Área do desenvolvedor

API Clínica nas Nuvens

Aqui você encontra informações sobre o fluxo de autenticação e exemplos de requisição para a API.

Documentação técnica/métodos disponíveis: https://api.clinicanasnuvens.com.br/swagger-ui.html

Introdução

O fluxo de autenticação para integração com as APIs do Clínica nas Nuvens é muito simples.

Para utilizar os métodos de API, a requisição deve autenticar em formato Basic, com as credenciais internas do Clínica nas Nuvens ou com as credenciais fornecidas para o parceiro (um client_id e um client_secret).

Caso você queira ser um parceiro de integrações e não possua as credenciais, você deve solicitá-las através do endereço api@clinicanasnuvens.com.br. Serão solicitados alguns dados sobre seu aplicativo e, caso aprovado pela nossa equipe, suas credenciais serão criadas.


Exemplo de requisição

De posse das credenciais(client_id, client_secret e token da clínica), pode-se efetuar requisições para a API pública do Clínica nas Nuvens, conforme o exemplo:

GET https://api.clinicanasnuvens.com.br/especialidade/lista
Autenticação
Basic {client_id}:{client_secret}
Headers
clinicaNasNuvens-cid identificador/token da clínica, fornecido através do menu Configurações -> Integrações -> API.

Formatos

Para conseguir efetuar requisições corretamente, é muito importante enviar um JSON válido e seguir determinados padrões conforme tabela abaixo:

Data yyyy-MM-dd
Hora HH:mm:ss
Data e hora yyyy-MM-dd HH:mm:ss

Nota: Nesta API, os índices dos arrays começam em 0 e não em 1. Portanto, o primeiro elemento do array está na posição 0.

Limites

Para melhor controle e performance do sistema como um todo, limitamos o consumo a 120 requisições/token/minuto. Ao exceder o limite, o cliente recebe erro 429 - Too many requests.