Pular para o conteúdo

API reference

The célula.in API has resource-oriented URLs, accepts JSON request bodies, and returns JSON responses. It uses standard HTTP methods and status codes, while resource documents follow JSON:API 1.0 conventions.

External API access is not self-service. A church must be approved and allowlisted by célula.in before an integration can call the API outside the official application.

After approval, célula.in provisions the client token required on every external request. Protected operations also require a credential that identifies the user or account. See Authentication for the complete flow.

Surface Path Purpose
Authenticated API /v1 Account data and management operations performed with a user access token.
Public API /p/v1 Account-scoped public content, events, courses, giving, and prospect forms.

Some account onboarding, confirmation, lead, and guest routes are available without a user access token. Each operation page identifies its authentication and permission requirements.

  • Introduction explains headers, requests, and resource documents.
  • Authentication explains integration, user, and public API credentials.
  • Errors defines the error document and HTTP status codes.
  • Pagination describes collection pagination.
  • Request IDs explains request tracing and support.
  • Rate limits describes throttling and retry headers.
  • Versioning defines how API versions are selected.