Documentazione API

L'API di Raisetalk in formato OpenAPI: documentazione generata dal codice e generazione di un SDK client nel linguaggio che preferite.

La documentazione completa è disponibile nell'applicazione Raisetalk. Aprire la documentazione nell'applicazione

Documentazione OpenAPI

La documentazione completa dell'API di Raisetalk è disponibile in formato OpenAPI al seguente indirizzo: https://api.raisetalk.com/docs.

Viene generata automaticamente a partire dal codice sorgente dell'API e aggiornata a ogni rilascio, il che garantisce che rispecchi sempre fedelmente il comportamento reale degli endpoint esposti.

Il file grezzo della specifica è accessibile anche all'indirizzo https://api.raisetalk.com/openapi.yaml.

Generare un SDK

A partire da questa specifica OpenAPI è facile generare un SDK client in praticamente qualsiasi linguaggio (PHP, Python, TypeScript, Java, Go, Ruby, C#, ecc.) tramite lo strumento openapi-generator-cli.

Esempio per generare un SDK PHP:

docker run --rm \
  -v "${PWD}:/local" \
  openapitools/openapi-generator-cli generate \
  -i https://api.raisetalk.com/openapi.yaml \
  -g php \
  -o /local/sdk/php

Per cambiare linguaggio di destinazione, basta sostituire il valore del parametro -g (ad esempio -g python, -g typescript-axios, -g java, ecc.).

L'elenco completo dei generatori disponibili e la documentazione dettagliata dello strumento si trovano sul sito ufficiale: https://openapi-generator.tech/.