✨Quick Start

Introduction

Integrating our services into your apps is designed to be straightforward and hassle-free. Here's a quick guide to get you started with our REST API.

Simple API requests

Our API uses standard HTTP methods, making it easy to integrate with any HTTP client These are the methods we commonly use:

• GET: Retrieve information from the server.

• POST: Send new data to the server.

Good to know: There's many more methods, however we only use GET and POST to make the API simpler and easier to understand.

Essential Headers

Include these headers to ensure your requests are processed correctly:

• Content-Type: Always set to application/json.

Authentication

Most of our services use API keys for authentication, which makes it super easy to secure your requests. Just include your key in the Authorization header.

Example:

Authorization: Bearer {api_key}

However, for Secton Link, we currently use sessions instead. We know it's not the best practice, and we're planning to switch to API keys soon to streamline the process.

Formatting

When sending GET requests, include your data as query parameters. Here's a quick example:

https://api.secton.org/v1/accounts?sort=name&status=active

However, when sending POST requests, format your data as JSON:

{
  "name": "Jane Doe",
  "email": "[e-mail]",
  "password": "securepassword123"
}

All responses are in JSON, providing a predictable structure for handling data. Here’s a sample response:

{
  "message": "Account retrieved successfully.",
  "data": {
    "id": "12345678",
    "name": "Jane Doe",
  }
}

Note: All responses also return an HTTP status code. (e.g. 200, 403, etc.)

Rate Limiting

We use rate limiting to ensure fair use of our services. If you hit the limit, you’ll receive a 429 Too Many Requests response.

By following these steps, you’ll see just how easy it is to integrate our services into your applications. For more detailed instructions, refer to the specific sections of our documentation.