Skip to main content
Welcome to the technical documentation for the JobAffinity communication interface. This REST API allows you to interact with our recruitment platform programmatically.

​
Overview

The JobAffinity REST API enables you to:
  • Access your job postings and applications
  • Manage recruitment processes
  • Consult and enrich your candidate database
  • Automate your workflows via webhooks

​
Key Features

Self-Discoverable

Intuitive navigation: only the root URL is needed

Self-Documented

JSON-Schema included in every response

RESTful

Standard REST architecture with HTTPS and JSON

Versioned

Version management for smooth migrations

​
Quick Start

1

Get your credentials

Contact support: [email protected]
2

Test authentication

curl -X GET https://jobaffinity.fr/restapi/v1 \
     --basic --user login:password
3

Explore the API

Use the URLs provided in responses to navigate the API

​
Base URL

https://jobaffinity.fr/restapi/v1
This root URL is the only entry point you need. All other URLs will be provided by the API itself.

​
Data Exchange Format

  • Protocol: HTTPS only
  • Methods: GET and POST
  • Format: JSON (application/json)
  • Authentication: HTTP Basic Auth

​
Rate Limiting

The API is rate-limited to 45 requests per minute per IP address. Exceeding this limit will result in HTTP 429 (Too Many Requests) responses.

​
Next Steps

Authentication

Learn how to authenticate and make your first requests

Architecture

Understand the self-discovery principle and navigation

Response Structure

Discover special fields and response structure

API Reference

Explore the complete endpoint documentation

​
Support

For any questions or assistance:
Important: Monitor the _expiration field in the root resource. If it becomes different from null, a migration to a new version will be required.