Quickstart

This guide walks you through obtaining an access token, fetching a signed URL, and embedding it as an iframe.

1. Get your API credentials

   Contact your RecruitiFi partner manager to receive your client ID and client secret. These credentials authenticate your application and are scoped to your partner organization.

2. Request an access token

   Exchange your credentials for a time-limited access token.

   curl --request POST \
     --url https://api.recruitifi.com/v1/auth/token \
     --header 'Content-Type: application/json' \
     --data '{
       "client_id": "your-client-id",
       "client_secret": "your-client-secret"
     }'

   You should receive a response containing your access token:

   {
     "access_token": "eyJhbGciOiJIUzI1NiIs...",
     "token_type": "bearer",
     "expires_in": 3600
   }

3. Fetch a signed link

   Request a signed URL for the settings page. Replace the query parameter values with your actual connector, client, and user identifiers.

   curl --request GET \
     --url 'https://api.recruitifi.com/v1/links/settings?connectorId=my-connector&clientId=my-client&userId=my-user' \
     --header 'X-Auth-Token: eyJhbGciOiJIUzI1NiIs...'

   The response contains a time-limited signed URL:

   {
     "url": "https://app.recruitifi.com/embed/settings?token=eyJhbGciOi...",
     "expiresAt": "2025-01-15T12:30:00Z"
   }

4. Embed the URL in an iframe

   Use the signed URL from the response as the src of an iframe in your application.

   <iframe
     src="https://app.recruitifi.com/embed/settings?token=eyJhbGciOi..."
     width="100%"
     height="600"
     frameborder="0"
     allow="clipboard-write"
     sandbox="allow-scripts allow-same-origin allow-forms allow-popups"
   ></iframe>

   The iframe renders the RecruitiFi settings view directly within your application. Your users interact with it without leaving your product.

Next steps

• Read the Iframe Embedding guide for security attributes, responsive sizing, and URL expiry handling.
• Explore the API Reference for full endpoint documentation.