BUILD

SDKs and client generation

Call the API directly or generate a typed client from the live OpenAPI document.

Download SDKs, CLI, WordPress plugin and Android app

OpenAPI 3.0

GET /api/openapi.json is generated by the running installation and includes its own server URL. Import it into Postman, Insomnia, Bruno, Swagger UI or an OpenAPI client generator.

Download OpenAPI JSON

Generate a client

npx @openapitools/openapi-generator-cli generate \
  -i https://api.shortfreeurl.com/api/openapi.json -g typescript-fetch -o ./shortfreeurl-client

openapi-generator-cli generate \
  -i https://api.shortfreeurl.com/api/openapi.json -g python -o ./shortfreeurl_client

oapi-codegen -generate types,client -package shortfreeurl \
  https://api.shortfreeurl.com/api/openapi.json > shortfreeurl.gen.go

Use any HTTP client

The API uses JSON requests and responses, conventional HTTP methods, ISO 8601 timestamps and standard status codes. There is no runtime SDK requirement.

Endpoint snippet generatorGenerate curl, JavaScript, Python, PHP, Go and Ruby snippets.→API referenceBrowse every resource and field.→Errors and limitsBuild safe retry and backoff behavior.→