{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f6ee768e-e2e8-4678-9b88-450e417c8d42","name":"Candidly White-Label Demo","description":"#### **Introduction**\n\nThis section details the protocol for generating tokens to support onboarding new companies, signing up, and signing in users within the Candidly platform. These API endpoints allow white-label partners to experience how the Candidly system can integrate seamlessly with their own applications. This demo provides a practical overview of the token-based authentication process, enabling partners to understand and test the user flow, from onboarding through login, as it would appear in their own systems.\n\n**Important Note**: This documentation is intended for demo purposes only. The actual implementation may differ, as the tokens generated by this API need to be created on the white-label partner's end. For testing and secure integration, please contact us to obtain:\n\n- **Base URL**: The primary endpoint to access Candidly's API.\n    \n- **Secret Token**: The authentication key for secure communication.\n    \n- **Full API Documentation**: Detailed documentation for the actual implementation.\n    \n\n**Terminology Overview**\n\n- **Base URL ({{base_url}})**: This is the primary endpoint of Candidly's API. All API requests for token creation and verification begin here.\n    \n- **Headers**:\n    \n    - **X-Secret-Token**: A unique secret token provided to ensure the authenticity of requests. This key allows Candidly to verify that incoming requests are from a trusted source.\n        \n\n**Steps to Run the Demo APIs**\n\n1. **Open Postman**\n    \n    - Click on **Run in Postman**.\n        \n    - A popup will appear with two options; choose either:\n        \n        - **Postman for Web**\n            \n        - **Postman for Mac**\n            \n2. **Import the Collection**\n    \n    - Once Postman is open, import the provided API collection.\n        \n3. **Configure the Environment**\n    \n    - Go to the **Environment** settings in the left bar.\n        \n    - Select **Sandbox** and edit the `base_url` and `secret_token` with the values provided by Candidly.\n        \n4. **Change the Environment to Sandbox**\n    \n    1. This will set the Sandbox environment as the active environment, allowing the API requests to use the `base_url` and `secret_token` configured for Sandbox.\n        \n        1. In Postman, go to the **top-right corner** of the interface.\n            \n        2. Click on the **current environment dropdown** (located in the top-right navbar).\n            \n        3. From the dropdown, select **Sandbox** as the environment.\n            \n5. **Access the Candidly White-Label Demo Collection**\n    \n    - Navigate to the imported collection labeled **Candidly White-Label Demo**.\n        \n    - Within the collection, you will find three API endpoints:\n        \n        - **Onboarding New Company** - Creates a new company profile.\n            \n        - **New User** - Registers a new user under the company.\n            \n        - **User Sign-In** - Authenticates a user to sign in.\n            \n6. **Simulate the Token-Based Process**\n    \n    - Each API call returns a token. Copy this token, paste it into a browser, and simulate the onboarding or login process as it would appear for a partner.\n        \n\nThese steps will allow you to test the demo APIs in Postman and experience the token-based interactions as a partner would\n\n**Error Example**\n\nBelow is an example of how Candidly returns errors to the white-label URL. This allows white-label partners to handle errors appropriately and display meaningful messages to their users.\n\nExample Error URL:\n\n`https://{{white-label-url}}/recruit/error?error=user_creation_failed&reason=email_taken`\n\nIn this example:\n\n- **white-label-url:** This is the URL provided by the partner, allowing Candidly to redirect users to this address if any errors occur during transitions.\n    \n    - **Note**: This api's is primarily for demonstration purposes, if an error occurs, users will see the error directly in the JSON response on the Candidly platform, rather than being redirected.This setup helps partners understand how error handling and redirection would work within an integrated white-label solution\n        \n- **error**: Specifies the error type. Here, `user_creation_failed` indicates that an error occurred during user creation.\n    \n- **reason**: Provides additional context for the error. In this case, `email_taken` suggests that the email address is already in use.\n    \n\nWhite-label partners can capture these parameters from the URL to identify issues and display user-friendly error messages","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33106990","team":6052232,"collectionId":"f6ee768e-e2e8-4678-9b88-450e417c8d42","publishedId":"2sAY4yf1ak","public":true,"publicUrl":"https://docs.wearecandidly.com","privateUrl":"https://go.postman.co/documentation/33106990-f6ee768e-e2e8-4678-9b88-450e417c8d42","customColor":{"top-bar":"01315a","right-sidebar":"01315a","highlight":"e55455"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/4e3f124f-2732-4831-8df2-2a5d86497d79/bG9nby5wbmc=","colors":{"top-bar":"01315a","right-sidebar":"01315a","highlight":"e55455"}},{"name":"light","logo":"https://content.pstmn.io/4e3f124f-2732-4831-8df2-2a5d86497d79/bG9nby5wbmc=","colors":{"top-bar":"01315a","right-sidebar":"01315a","highlight":"e55455"}}]}},"version":"8.11.6","publishDate":"2024-11-07T07:08:02.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/4e3f124f-2732-4831-8df2-2a5d86497d79/bG9nby5wbmc=","logoDark":"https://content.pstmn.io/4e3f124f-2732-4831-8df2-2a5d86497d79/bG9nby5wbmc="}},"statusCode":200},"environments":[{"name":"Sandbox","id":"9edd4636-2405-4bd8-8465-4dcc41b18754","owner":"33106990","values":[{"key":"base_url","value":"{{base_url}}","enabled":true,"type":"default"},{"key":"secret_token","value":"{{secret_token}}","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e2befc5353ccba64030d21b2b8c11102768de4a525d22039a8178e9a1e1f0c59","favicon":"https://wearecandidly.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Sandbox","value":"33106990-9edd4636-2405-4bd8-8465-4dcc41b18754"}],"canonicalUrl":"https://docs.wearecandidly.com/view/metadata/2sAY4yf1ak"}