API
Autenticazione, X-CommunityId, errori, paginazione, l’SDK /sdk.js e ogni endpoint.
- Introduzione all'APIL'API REST di Memberfy: indirizzo, formato, header e da dove iniziare l'integrazione.
- AutenticazioneCome ottenere il token con email e password, inviarlo in ogni chiamata, quanto dura, le rotte pubbliche, agire a nome di un altro profilo e come predisporre un account di integrazione sicuro.
- X-CommunityIdL'header che indica in quale community avviene ogni chiamata e in quale viene verificato il tuo ruolo. Perché nessuna rotta porta la community nel percorso, dove trovare l'id della community e gli errori di chi lo dimentica.
- Ordine di creazioneChe cosa deve esistere prima di ogni chiamata, da dove arriva ogni id, la sequenza dei flussi più comuni e gli errori che compaiono quando si salta un passaggio.
- Risposte ed erroriL'involucro di ogni risposta, l'array errors che arriva sempre, i codici HTTP e che cosa fare con ciascuno, i messaggi di validazione e di regola di business, la lingua dei messaggi e gli elementi rimossi.
- PaginazioneCome gli elenchi si dividono in pagine con page e limit, il blocco pagination della risposta, come scorrere tutto e come si combinano filtri e paginazione.
- SDK JavaScriptIl client che l'API pubblica su /sdk.js e /sdk.mjs, generato dalla specifica stessa. Come caricarlo nel browser e in Node, i metodi per argomento, come passare parametri e corpo, la gestione degli errori e le opzioni del client.
- Riferimento APIOgni endpoint pubblico dell’API, raggruppato per argomento, generato dalla specifica OpenAPI pubblicata dall’API stessa.