Ir para o conteúdo

Documentação de Integração da API: PhotoBucketAPI

Visão Geral

A PhotoBucketAPI é uma API que permite buscar fotos armazenadas em um bucket e retornar as URLs dessas imagens. Esta API é útil para sistemas que necessitam acessar fotos armazenadas em um bucket de forma organizada e eficiente.

  • Obs: Somente o perfil API Integration tem acesso a esta funcionalidade.

Endpoints

URLs Base

  • Homologação: https://fsv2-replica-api-prd.biomtech.com.br/api
  • Produção: https://prod-fsv2-api.biomtech.com.br/api

1. Listar Fotos Paginadas

URL 

1
GET /Student/all/photos

Parâmetros de Consulta (Query Parameters) - PageNumber (int): O número da página que deseja consultar. - PageSize (int): O número de fotos a serem retornadas por página.

Headers - accept: text/plain - X-Selected-User-Profile-Id: {idProfile} - Authorization: Bearer {token}

Exemplo de Requisição (Homologação) 

1
2
3
4
curl --location 'https://fsv2-replica-api-prd.biomtech.com.br/api/Student/all/photos?PageNumber=1&PageSize=100' \
--header 'accept: text/plain' \
--header 'X-Selected-User-Profile-Id: idProfile' \
--header 'Authorization: Bearer token'

Exemplo de Requisição (Produção) 

1
2
3
4
curl --location 'https://prod-fsv2-api.biomtech.com.br/api/Student/all/photos?PageNumber=1&PageSize=100' \
--header 'accept: text/plain' \
--header 'X-Selected-User-Profile-Id: idProfile' \
--header 'Authorization: Bearer token'

2. Listar Fotos por IDs de Origem

URL 

1
GET /Student/all/photos

Parâmetros de Consulta (Query Parameters) - OriginIds (string): IDs de origem das fotos que deseja consultar. Podem ser passados múltiplos IDs separados por vírgula.

Headers - accept: text/plain - X-Selected-User-Profile-Id: {idProfile} - Authorization: Bearer {token}

Exemplo de Requisição (Homologação) 

1
2
3
4
curl --location 'https://fsv2-replica-api-prd.biomtech.com.br/api/Student/all/photos?OriginIds=id1&OriginIds=id2' \
--header 'accept: text/plain' \
--header 'X-Selected-User-Profile-Id: idProfile' \
--header 'Authorization: Bearer token'

Exemplo de Requisição (Produção) 

1
2
3
4
curl --location 'https://prod-fsv2-api.biomtech.com.br/api/Student/all/photos?OriginIds=id1&OriginIds=id2' \
--header 'accept: text/plain' \
--header 'X-Selected-User-Profile-Id: idProfile' \
--header 'Authorization: Bearer token'

Limitações de Requisição

Nos headers da resposta, serão retornados dados referentes às limitações de requisições por dia, conforme abaixo:

  • X-Ratelimit-Limit: Número máximo de requisições permitidas por dia.
  • X-Ratelimit-Remaining: Número de requisições restantes no dia.
  • X-Ratelimit-Used: Número de requisições já utilizadas no dia.
  • X-Ratelimit-Reset: Data e hora em que a contagem de requisições será resetada.

Exemplos de Headers de Resposta

1
2
3
4
X-Ratelimit-Limit: 1000
X-Ratelimit-Remaining: 900
X-Ratelimit-Used: 100
X-Ratelimit-Reset: 2024-07-19T00:00:00Z

Autenticação

A API utiliza autenticação via Bearer Token. Certifique-se de incluir o token válido no header Authorization em todas as requisições.