API
Autenticação, X-CommunityId, erros, paginação, o SDK em /sdk.js e a referência de cada endpoint.
- Introdução à APIA API REST da Memberfy: endereço, formato, headers e por onde começar a integrar.
- AutenticaçãoComo obter o token com e-mail e senha, enviá-lo em cada chamada, quanto tempo ele vale, as rotas públicas, agir em nome de outro perfil e como montar uma conta de integração segura.
- X-CommunityIdO header que diz em qual comunidade cada chamada acontece e em qual o seu papel é conferido. Por que nenhuma rota leva a comunidade no caminho, onde encontrar o id da comunidade e os erros de quem esquece.
- Ordem de criaçãoO que precisa existir antes de cada chamada, de onde vem cada id, a sequência dos fluxos comuns e os erros que aparecem quando um passo é pulado.
- Respostas e errosO envelope de toda resposta, o array errors que vem sempre, os códigos HTTP e o que fazer com cada um, as mensagens de validação e de negócio, o idioma das mensagens e itens removidos.
- PaginaçãoComo as listagens se dividem em páginas com page e limit, o bloco pagination da resposta, como percorrer tudo e como filtros e paginação se combinam.
- SDK JavaScriptO cliente que a API publica em /sdk.js e /sdk.mjs, gerado da própria especificação. Como carregar no navegador e no Node, os métodos por assunto, como passar parâmetros e corpo, o tratamento de erro e as opções do cliente.
- Referência da APICada endpoint público da API, agrupado por assunto, gerado a partir da especificação OpenAPI que a própria API publica.