Maya Pets DevelopersAPI Documentation
DOCUMENTAÇÃO PARA INTEGRAÇÕES

Conecte sua plataforma
ao ecossistema Maya Pets.

Integre tutores, condomínios, pets e fotos usando uma API REST com autenticação OAuth 2.0 e respostas JSON.

Começar integração → Explorar endpoints
✓ REST API ✓ OAuth 2.0 ✓ JSON
request.jsonSANDBOX
GET /v1/pets?pagina=1&limite=20
{
  "status": "success",
  "dados": [
    {
      "nome": "Bob",
      "categoria_uuid": "...",
      "raca_uuid": "..."
    }
  ],
  "paginacao": { "pagina": 1 }
}
✓ 200 OK · resposta JSON
🔐 OAuth 2.0
🐾 Pets & tutores
ⓘ

Ambiente documentado: Sandbox. Use credenciais de teste. Não coloque client secrets, tokens reais ou dados pessoais no código público nem em chamados.

https://sandbox-api.mayapets.com.br
COMECE POR AQUI

Primeiros passos

Faça a autenticação, guarde o token com segurança e envie-o nas chamadas protegidas.

01
🔑

Obtenha as credenciais

Solicite ao time Maya Pets o client_id e o client_secret do seu cliente de sandbox.

02
🎟️

Gere um access token

Envie grant_type=client_credentials ao endpoint OAuth usando formulário URL-encoded.

03
🔗

Consuma a API

Inclua Authorization: Bearer SEU_TOKEN e envie JSON nas operações de escrita.

EXEMPLO PRÁTICO

1. Solicitar token

curl -X POST \
  "https://sandbox-api.mayapets.com.br/v1/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "grant_type=client_credentials" \
  --data-urlencode "client_id=SEU_CLIENT_ID" \
  --data-urlencode "client_secret=SEU_CLIENT_SECRET"
O token retornado deve ser tratado como uma credencial. Não o exponha no frontend público.
SEGUNDA CHAMADA

2. Listar raças

curl -X GET \
  "https://sandbox-api.mayapets.com.br/v1/racas?pagina=1&limite=20" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN" \
  -H "Accept: application/json"
A listagem usa paginação. O limite máximo documentado no código é 100 itens por página.
REFERÊNCIA DA API

Recursos disponíveis

Resumo dos grupos de endpoints identificados no roteador e nos módulos da API sandbox.

🛡️AutenticaçãoOAuth token e contexto do cliente↗ 🏢CondomíniosListagem, consulta e atualização permitida↗ 👤Usuários / tutoresCadastro, consulta, atualização e desativação↗ 🐾PetsCRUD e associação a tutor, categoria e raça↗ 🖼️Fotos de petsUpload multipart e URLs temporárias S3↗ 📚CatálogosCategorias e raças ativas↗
EXPLORADOR INTERATIVO

Swagger UI

Consulte os contratos OpenAPI e experimente chamadas. A execução no navegador depende de a API permitir CORS para este domínio.

Antes de executar: obtenha credenciais de sandbox. Nunca use credenciais de produção neste portal.
COMPORTAMENTO DA API

Boas práticas de integração

01

Autenticação em todas as rotas protegidas

Envie o token no cabeçalho Authorization. Se receber 401, obtenha um novo token e tente novamente.

02

Respeite o isolamento por cliente

Os recursos retornados são limitados aos condomínios vinculados ao cliente OAuth autenticado.

03

Use UUIDs públicos

Relacione pets, tutores, categorias, raças e condomínios pelos campos UUID aceitos pela API.

04

Trate erros e paginação

Verifique o status HTTP e os campos status, message, dados e paginacao quando presentes.