inChurch
Getting Started

Overview

This guide will walk you through everything you need to know to start using the InChurch API effectively.

Prerequisites

Before you begin, ensure you have:

  • An active InChurch account with administrator privileges
  • Basic understanding of REST APIs and HTTP methods
  • A development environment for testing API calls

Quick Start Checklist

  1. Create an API Client in your InChurch admin panel
  2. Configure Permissions for your API client
  3. Test Authentication with your API credentials
  4. Set up Webhooks (optional but recommended)

API Base URL

All API requests should be made to:

Code
https://inradar.com.br/public

Authentication Overview

The InChurch API uses API Key authentication with the following components:

  • API Key: A public, immutable identifier for your client
  • API Secret: A private key used for request signing (shown only once)

Rate Limits

All API clients are limited to 200 requests per minute. When you exceed this limit, you'll receive a 429 Too Many Requests response with a Retry-After header.

Response Format

All API responses follow a consistent JSON format:

JSONCode
{ "count": 0, "next": "https://www.example.com/path/to/resource", "previous": "https://www.example.com/path/to/resource", "results": [] }

Error Handling

The API uses standard HTTP status codes and returns detailed error information:

JSONCode
{ "error": { "code": "VALIDATION_ERROR", "message": "The given data was invalid.", "details": { "email": ["The email field is required."] } } }

Next Steps

  1. Set up Authentication →
  2. Understand Rate Limits →
  3. Learn about Errors →
  4. Explore API Reference →
Last modified on