API-Dokumentation Sharepool

Informationen zur Integration der Sharepool-Komponente.
Mit der Sharepool-Komponente können Sie hochwertige Kandidatenprofile als interaktive Webprofile mit Ihren Kunden teilen. Der zentrale Mehrwert dieser Komponente ist, dass Sie mit nur einem Link beliebig viele Kandidatenprofile mit beliebig vielen Kunden teilen können.

Stand: 08/22

Einführung

Die Sharepool API ist nach den Prinzipien von REST aufgebaut. Es stehen mehrere Endpunkte zur Verfügung:

Sharepool anlegen
Sharepool abfragen
Sharepool updaten
Sharepool löschen
Kandidatenprofil hinzufügen
Kandidatenprofil entfernen
Sharepool-Link erhalten

Alle Zugriffe erfolgen über HTTPS.

Wichtig: Ungesicherte HTTP-Anfragen nehmen wir aus Sicherheitsgründen nicht entgegen. Es werden nur HTTPS-Anfragen angenommen.

Authentifizierung

Jeder Nutzer unserer API erhält individuelle Zugangsdaten. Sollten Sie Interesse an einer Integration unseres Services haben, dann schicken Sie uns eine kurze Email an info@verlingo.de

API-Schlüssel

Diese Zugangsdaten geben Sie einfach per HTTP-Authorization Header als API-Schlüssel an.

HTTP-VERB: ("Authorization", IHR_API-Schlüssel)

HTTP Status-Codes

Im Folgenden finden Sie eine Liste der wichtigsten HTTP-Status-Codes, die die verlingo API ausgibt, und wie Sie diese interpretieren können. Im Allgemeinen stehen 200er-Codes für einen erfolgreichen Request, 400er für einen Fehler in den Request-Daten (zum Beispiel fehlt ein zwingend anzugebender Parameter) und 500er für einen Fehler auf unseren Servern.

Code	Bedeutung
200 OK	Eine erfolgreiche Anfrage
400 Bad Request	Liegt meist an einem Syntax-Fehler im Request-Body
401 Unauthorized	Falsche oder fehlende Authentifizierung
404 Not Found	Die Ressource konnte nicht gefunden werden
406 Not Acceptable	Das Format der Anfrage wird nicht unterstützt
417 Expectation Failed	Die übermittelten Informationen sind fehlerhaft oder unvollständig
500, 502, 503 Server Error	Serverfehler. Wiederholen Sie die Anfrage nach kurzer Zeit und melden Sie sich bei uns, falls der Fehler dauerhaft auftritt

Sharepool anlegen

POSThttps://recruiting.verlingo.de/api/talentscout/v1/sharepool

Request / Anfrage

http-Header:

"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel

http-Body:

{
    "Title": "title",
    "Description": "description",
    "Logo": {
        "Format": "png | jpeg",
        "ImageB64": "base64"
    },
    "CandidatesAndVariants": [
        {
            "CandidateId": "candidateId",
            "VariantId": "variantId",
            "ExternalInfos": {
                Optionale benutzerdefinierte Informationen als JSON
            }
        },
        …
    ],
    "Config": {
        "ContactFormMandatory": boolean (optional),
        "UseUserOfExternalUserId": boolean (optional)
    },
    "ExternalInfos": {
        "UserId": "userId (optional)",
        "Additional": {
            Optionale benutzerdefinierte Informationen als JSON
        }
    }
}

Wenn das Attribut 'Config.UseUserOfExternalUserId' auf true gesetzt wird, muss das Attribut 'ExternalInfos.UserId' ebenfalls übermittelt werden und die Aktion wird dann unter diesem User ausgeführt.

Response / Antwort

Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.

{
    "SharepoolId": "sharepoolId",
    "Title": "title",
    "Description": "description",
    "CandidatesAndVariants": [
        {
            "CandidateId": "candidateId",
            "VariantId": "variantId",
            "Variant": {
                "VariantId": "variantId",
                "VariantName": "variantName",
                "CreatedAt": "2021-01-01T14:28:23.234Z",
                "CreatedBy": "createdBy",
                "UpdatedAt": "2021-01-01T14:28:23.234Z",
                "UpdatedBy": "updatedBy",
                "EditLink": "editLink"
            },
            "ExternalInfos": externalInfos
        },
        …
    ],
    "Active": boolean,
    "ContactFormMandatory": boolean,
    "ExternalInfos": externalInfos,
    "RemainingDaysUntilAutoDeactivation": 28,
    "DateOfAutoDeactivation": "2022-09-20",
    "CreatedAt": "2022-08-23T15:43:01.042Z",
    "UpdatedAt": "2022-08-23T15:43:01.042Z",
    "CreatedBy": "createdBy",
    "UpdatedBy": "updatedBy"
}

Sharepool abfragen

GEThttps://recruiting.verlingo.de/api/talentscout/v1/sharepool

Request / Anfrage

http-Header:

"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel

http-Body:

{
    "SharepoolId": "sharepoolId"
}

Response / Antwort

Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.

{
    "SharepoolId": "sharepoolId",
    "Title": "title",
    "Description": "description",
    "CandidatesAndVariants": [
        {
            "CandidateId": "candidateId",
            "VariantId": "variantId",
            "Variant": {
                "VariantId": "variantId",
                "VariantName": "variantName",
                "CreatedAt": "2021-01-01T14:28:23.234Z",
                "CreatedBy": "createdBy",
                "UpdatedAt": "2021-01-01T14:28:23.234Z",
                "UpdatedBy": "updatedBy",
                "EditLink": "editLink"
            },
            "ExternalInfos": externalInfos
        },
        …
    ],
    "Active": boolean,
    "ContactFormMandatory": boolean,
    "ExternalInfos": externalInfos,
    "RemainingDaysUntilAutoDeactivation": 28,
    "DateOfAutoDeactivation": "2022-09-20",
    "CreatedAt": "2022-08-23T15:43:01.042Z",
    "UpdatedAt": "2022-08-23T15:43:01.042Z",
    "CreatedBy": "createdBy",
    "UpdatedBy": "updatedBy"
}

Sharepool updaten

PUThttps://recruiting.verlingo.de/api/talentscout/v1/sharepool

Request / Anfrage

http-Header:

"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel

http-Body:

{
    "SharepoolId": "sharepoolId",
    "Title": "title",
    "Description": "description",
    "Logo": {
        "Format": "png | jpeg",
        "ImageB64": "base64"
    },
    "CandidatesAndVariants": [
        {
            "CandidateId": "candidateId",
            "VariantId": "variantId",
            "ExternalInfos": {
                Optionale benutzerdefinierte Informationen als JSON
            }
        },
        …
    ],
    "Active": boolean,
    "Config": {
        "ContactFormMandatory": boolean,
        "UseUserOfExternalUserId": boolean
    },
    "ExternalInfos": {
        "UserId": "userId",
        "Additional": {
            Optionale benutzerdefinierte Informationen als JSON
        }
    }
}

Sie können nur die Informationen übergeben, die aktualisiert werden sollen.

Response / Antwort

Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.

{
    "SharepoolId": "sharepoolId",
    "Title": "title",
    "Description": "description",
    "CandidatesAndVariants": [
        {
            "CandidateId": "candidateId",
            "VariantId": "variantId",
            "Variant": {
                "VariantId": "variantId",
                "VariantName": "variantName",
                "CreatedAt": "2021-01-01T14:28:23.234Z",
                "CreatedBy": "createdBy",
                "UpdatedAt": "2021-01-01T14:28:23.234Z",
                "UpdatedBy": "updatedBy",
                "EditLink": "editLink"
            },
            "ExternalInfos": externalInfos
        },
        …
    ],
    "Active": boolean,
    "ContactFormMandatory": boolean,
    "ExternalInfos": externalInfos,
    "RemainingDaysUntilAutoDeactivation": 28,
    "DateOfAutoDeactivation": "2022-09-20",
    "CreatedAt": "2022-08-23T15:43:01.042Z",
    "UpdatedAt": "2022-08-23T15:43:01.042Z",
    "CreatedBy": "createdBy",
    "UpdatedBy": "updatedBy"
}

Sharepool löschen

DELETEhttps://recruiting.verlingo.de/api/talentscout/v1/sharepool

Request / Anfrage

http-Header:

"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel

http-Body:

{
    "SharepoolId": "sharepoolId",
    "Config": {
        "UseUserOfExternalUserId": boolean
    },
    "ExternalInfos": {
        "UserId": "userId"
    }
}

Response / Antwort

Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.

{
    "message": "Sharepool successfully deleted."
}

Kandidatenprofil hinzufügen

POSThttps://recruiting.verlingo.de/api/talentscout/v1/sharepool/candidatesandvariants

Request / Anfrage

http-Header:

"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel

http-Body:

{
    "SharepoolId": "sharepoolId",
    "AddCandidateId": "candidateId",
    "AddVariantId": "variantId",
    "AddExternalInfos": {
        Optionale benutzerdefinierte Informationen als JSON
    },
    "Config": {
        "UseUserOfExternalUserId": boolean
    },
    "ExternalInfos": {
        "UserId": "userId"
    }
}

Response / Antwort

Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.

{
    "SharepoolId": "sharepoolId",
    "Title": "title",
    "Description": "description",
    "CandidatesAndVariants": [
        {
            "CandidateId": "candidateId",
            "VariantId": "variantId",
            "Variant": {
                "VariantId": "variantId",
                "VariantName": "variantName",
                "CreatedAt": "2021-01-01T14:28:23.234Z",
                "CreatedBy": "createdBy",
                "UpdatedAt": "2021-01-01T14:28:23.234Z",
                "UpdatedBy": "updatedBy",
                "EditLink": "editLink"
            },
            "ExternalInfos": externalInfos
        },
        …
    ],
    "Active": boolean,
    "ContactFormMandatory": boolean,
    "ExternalInfos": externalInfos,
    "RemainingDaysUntilAutoDeactivation": 28,
    "DateOfAutoDeactivation": "2022-09-20",
    "CreatedAt": "2022-08-23T15:43:01.042Z",
    "UpdatedAt": "2022-08-23T15:43:01.042Z",
    "CreatedBy": "createdBy",
    "UpdatedBy": "updatedBy"
}

Kandidatenprofil entfernen

DELETEhttps://recruiting.verlingo.de/api/talentscout/v1/sharepool/candidatesandvariants

Request / Anfrage

http-Header:

"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel

http-Body:

{
    "SharepoolId": "sharepoolId",
    "RemoveCandidateId": "candidateId",
    "RemoveVariantId": "variantId",
    "Config": {
        "UseUserOfExternalUserId": boolean
    },
    "ExternalInfos": {
        "UserId": "userId"
    }
}

Response / Antwort

Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.

{
    "SharepoolId": "sharepoolId",
    "Title": "title",
    "Description": "description",
    "CandidatesAndVariants": [
        {
            "CandidateId": "candidateId",
            "VariantId": "variantId",
            "Variant": {
                "VariantId": "variantId",
                "VariantName": "variantName",
                "CreatedAt": "2021-01-01T14:28:23.234Z",
                "CreatedBy": "createdBy",
                "UpdatedAt": "2021-01-01T14:28:23.234Z",
                "UpdatedBy": "updatedBy",
                "EditLink": "editLink"
            },
            "ExternalInfos": externalInfos
        },
        …
    ],
    "Active": boolean,
    "ContactFormMandatory": boolean,
    "ExternalInfos": externalInfos,
    "RemainingDaysUntilAutoDeactivation": 28,
    "DateOfAutoDeactivation": "2022-09-20",
    "CreatedAt": "2022-08-23T15:43:01.042Z",
    "UpdatedAt": "2022-08-23T15:43:01.042Z",
    "CreatedBy": "createdBy",
    "UpdatedBy": "updatedBy"
}

Sharepool-Link erhalten

GEThttps://recruiting.verlingo.de/api/talentscout/v1/sharepool/link

Request / Anfrage

http-Header:

"Content-Type": "application/json"
"Authorization": IHR_API-Schlüssel

http-Body:

{
    "SharepoolId": "sharepoolId",
    "Customer": "customer",
    "Config": {
        "UseUserOfExternalUserId": boolean
    },
    "ExternalInfos": {
        "UserId": "userId"
    }
}

Das Attribut 'Customer' ist obligatorisch und dient zur Identifikation des Empfängers sowie zum Nachverfolgen der von ihm ausgeführten Aktionen.

Response / Antwort

Sie erhalten von unserer API immer eine Antwort im JSON-Format und den HTTP-Statuscode 200 bei einer erfolgreichen Antwort.

{
    "SharepoolId": "sharepoolId",
    "Active": boolean,
    "ContactFormMandatory": boolean,
    "RemainingDaysUntilAutoDeactivation": 28,
    "DateOfAutoDeactivation": "2022-09-20",
    "Customer": "customer",
    "CustomerLink": "customerLink",
    "PreviewLink": "previewLink"
}