A API Reach 360 é organizada em torno do REST. Nossa API tem URLs previsíveis orientadas a recursos, aceita corpos de solicitação codificados em JSON, retorna respostas codificadas em JSON e usa códigos de resposta HTTP padrão, autenticação e verbos.

• A API Reach 360 está disponível em https://api.reach360.com
• A API EU Reach 360 está disponível em https://api.reach360.eu

Para obter as atualizações mais recentes, consulte o Changelog.

Clique aqui para saber como gerar chaves de API no Reach 360.

• Autentificação
• Controle de versão
• Paginação
• Erros
• Suporte

Autentificação

Sua chave de API é usada para autenticar solicitações e identificar sua conta do Reach 360. Ele deve ser armazenado de forma segura: certifique-se de que ele seja mantido fora do controle de versão e só possa ser acessado por quem precisa dele. Trate-a como qualquer outra senha.

Todas as solicitações de API devem usar a autenticação do portador: sua chave de API deve ser fornecida como um token do portador no Authorization cabeçalho. Todas as solicitações de API devem ser feitas por HTTPS. As chamadas feitas por HTTP simples falharão. As solicitações de API sem autenticação também falharão.

Controle de versão

Quando forem feitas alterações em nossa API que não sejam compatíveis com versões anteriores, lançaremos uma versão nova e datada da API. A versão inicial da API do 2023-04-04 será assumida quando suas solicitações não incluírem um API-Version cabeçalho.

Quando um cabeçalho de versão de API inválido for fornecido, você receberá uma resposta 400 com o código invalid_api_version de erro. As solicitações de API bem-sucedidas incluirão um cabeçalho de API-Version resposta, indicando qual versão da API sua solicitação foi processada.

Sempre que uma nova versão da API é lançada, nós a mencionamos explicitamente em nosso Changelog, além de criar uma nova entrada na página Versões da API.

Exemplo de solicitação

curl -i < https://api.reach360.com/users >\\ 
 -H “Autorização: portador $API_KEY” -H “Versão da API: 2020-07-16" 
 

Paginação

Todos os endpoints paginados são baseados em cursor e retornam uma propriedade. nextUrl Caso contrárionull, nextUrl indica que pode haver resultados adicionais. Uma GET solicitação pode ser feita ao nextUrl URL para obter a próxima página de resultados. Um nextUrl de null indica que não há mais resultados. Todos os endpoints paginados oferecem suporte a um parâmetro de sequência de caracteres de limit consulta que especifica o número máximo de resultados a serem retornados em uma única resposta. Todos os endpoints que retornam uma lista de resultados oferecem suporte à paginação.

Nota: O limit valor deve estar entre 1 e 100 (exceto quando indicado de outra forma; e o padrão é 50 se não for especificado).

Endpoints que suportam paginação

• GET /courses
• GET /groups
• GET /groups/{groupId}/users
• GET /invitations
• GET /learning-paths
• GET /learning-paths/{learningPathId}
• GET /learning-paths/{learningPathId}/courses
• GET /groups/{groupId}/managers
• GET /users/{userId}/managing-groups
• GET /reports/activity
• GET /reports/courses/{courseId}
• GET /reports/learners/{userId}
• GET /reports/learning-paths/{learningPathId}/courses
• GET /reports/learning-paths/{learningPathId}/learners
• GET /users
• GET /users/{userId}/groups
• GET /groups/{groupId}/reporters
• GET /users/{userId}/reporting-groups
• GET /webhooks

Erros

Uma resposta 400 contendo uma lista de errors será retornada quando a solicitação não for válida. Alguns códigos de erro comuns incluem:

• validation_failed: o corpo da solicitação tem um erro de validação
• invalid_email: A email propriedade não é um endereço de e-mail formatado corretamente
• missing_api_key: falta uma chave de API na solicitação
• invalid_api_key: A chave de API fornecida é inválida
• invalid_content_type: A solicitação está ausente/tem o tipo de conteúdo incorreto

Exemplo de resposta

{
“errors”: [
{
“code”: “invalid_email”, 
 “message”: “\\" email\\” deve ser um e-mail válido”
}]} 
 
 

Suporte

Estamos entusiasmados por você conectar o Reach 360 às ferramentas que você mais usa. O suporte pode confirmar se as chamadas de API estão funcionando conforme o esperado, mas não podemos ajudar na criação de scripts personalizados ou na depuração de aplicativos de terceiros.

Se você tiver algum problema, faremos o possível para ajudá-lo a solucionar o problema solicitando:

• A versão mais simples da chamada que você está fazendo com a API
• Se o problema pode ser replicado fora do seu aplicativo
• Cabeçalhos de solicitação, cabeçalhos de resposta (incluindo o cabeçalho X-Request-Id), corpos de solicitação e corpos de resposta

Reach nossa equipe e conte-nos o que está acontecendo. Vamos começar a partir daí!