Developers
Introdução
A API principal da Sofia é uma API REST na qual você pode gerenciar todos os principais recursos da Sofia.
A url base para chamar qualquer endpoint é: https://gateway-api.prod.sofiapegasus.com/core-api.
Apenas os endpoints que começam com /external podem ser chamados de forma pública.
Para testar e explorar a API você pode criar uma nova organização de teste e chamar os endpoints para essa organização. Toda nova organização possui 7 dias de TRIAL.
Autenticação
Para se autenticar na API na Sofia, basta gerar no app (tela de perfil) uma chave de API para o seu usuário e enviar nos requests (header authorization bearer token) essa chave junto com o id da organização:
Authorization: Bearer ak_18YWRB1HGJHVHHJH57766HHYH7:org_30vSXwOEEH2hbdsaHGBJ77689veqZ9ExRecursos
Veja quais são os endpoints para gerenciar os principais recursos de sua organização.
FAQ
Os endpoints de busca/listagem geralmente retornam os items paginados.
Nesses endpoints, deverá ser enviado o tamanho da página (pageSize) e qual página queremos (pageIndex, começa no 0) no query params do request.