AFaffinda
Search & Match

Create a signed URL for the embeddable resume search tool

Changed on

Create and return a signed URL of the resume search tool which then can be embedded on a web page. An optional parameter config_override can be passed to override the user-level configurations of the embeddable resume search tool.

post/v3/resume_search/embed

Request

Request body

Example request

{
  "configOverride": {
    "maxResults": 10,
    "indices": [
      "all-resumes",
      "my-index"
    ],
    "userId": 1234,
    "username": "big.smoke",
    "actions": [
      {
        "label": "Add to shortlist",
        "eventName": "addToShortlist"
      }
    ],
    "customFieldsConfig": [
      {
        "dataPoint": "RdNAniIH",
        "weight": 0.5
      }
    ],
    "distanceUnit": "km"
  }
}

Response

Successfully created a signed URL.

urlstring

The signed URL for the embedable search tool.

Example response

{
  "url": "https://app.affinda.com/resume-search?signature=eyJhbGxvd19wZGZfZG"
}

Changes

  • 978cf99a2ac0Revision changes
    • info

      api tag Search & Match added

    • info

      api tag Search & Match API - Embedding removed

  • c3123d7b7301Revision changes
    • breaking

      added to the / request property allOf list

    • warning

      the / request property's min was set to 1.00

    • info

      added the new optional request property /

    • info

      added the new optional request property /