Referência da API

As APIs do SEO for Jobs permitem-lhe integrar o Google for Jobs com facilidade e ir além da integração básica de publicação de ofertas de emprego pronta a utilizar.

Registe-se e solicite o token da API aqui: https://app.seo-for-jobs.com/register

O URL raiz da API é https://app.seo-for-jobs.com/api/public.. O token da API para autenticação pode ser solicitado na sua conta SEO for Jobs. É necessário um pacote ativo para utilizar a API. O token tem de ser enviado através do cabeçalho adicional "x-api-token". O limite de pedidos é de 50 pedidos por hora e pode ser aumentado mediante pedido.

GET /jobs

Obter uma lista de todas as ofertas de emprego na sua conta.

Parâmetros:

nenhum

Resposta (Exemplo):

{
list: [
{
id: "2fd59d17-14ea-4b86-a3d8-c3126db5fbc6",
title: "SAP S/4HANA Senior Developer",
description: "Lorem ipsum dolor sit amet
consetetur ..."
...
},
{...}
]
}

CURL (Exemplo):

$curl - XGET - H 'x-api-key: cca265e6-5c40-4187-a0e9-713b4a9c453f' 'https://app.seo-for-jobs.com/api/public/jobs'

POST /job

Criar um novo anúncio de emprego na sua conta.

Parâmetros:

• status: Um dos seguintes "DRAFT" ou "PUBLISHED"

• título: String

• descrição: descrição HTML (etiquetas permitidas: br, ul, li)

• employmentType: NULL ou uma lista de "INTERN", "PERDIEM", "FULLTIME", "PARTTIME", "TEMPORARY", "VOLUNTEER", "CONTRACTOR" (ex.: ["FULLTIME", "PARTTIME"])

• salaryCurrency: NULL ou uma destas moedas "EUR", "CHF", "INR", "JPY", "USD"

• salaryValue: Número (por exemplo: 42.00)

• salaryUnit: NULL ou um destes "DAY", "HOUR", "WEEK", "YEAR", "MONTH"

• streetAndNo: String

• cidade: String

• postalCode: String (por causa dos zeros à esquerda)

• countryCode: Código de país i18n (por exemplo, "DE" ou "FR").

• companyName: Cadeiade caracteres

• companyLogoUrl: URL completo para um logótipo (250px x 250px, .png, .jpeg, .jpg)

• redirectUrl: URL completo para redirecionar após clicar no "Botão candidatar-se" no Google for Jobs.

Resposta (exemplo):

{
id: "2fd59d17-14ea-4b86-a3d8-c3126db5fbc6"
status: "PUBLISHED",
title: "SAP S/4HANA Senior Developer",
description: "Lorem ipsum dolor sit amet
consetetur ..."
...
}

CURL (Exemplo):

$curl - XPOST - H 'x-api-key: cca265e6-5c40-4187-a0e9-713b4a9c453f' - H "Content-type: application/json" - d '{status: "PUBLISHED",title: "SAP S/4HANA Senior Developer",description: "Lore Ipsum ...",employmentType: ["FULLTIME", "PARTTIME"],streetAndNo: "Amelungstraße 8",city: "Hamburg",postalCode: "20354",countryCode: "DE",companyName: "SFJ",redirectUrl: "https://www.seo-for-jobs.com/de/jobs/sap-hana-senior-developer"}' 'https://app.seo-for-jobs.com/api/public/job'

PUT /job/{id}

Atualizar um anúncio de emprego existente com o correspondente {id}. Apenas os parâmetros apresentados serão actualizados. A atualização será automaticamente enviada para o Google se o estado for "PUBLISHED" após o processo de atualização.

Parâmetro:

• estado: Um dos seguintes "DRAFT" ou "PUBLISHED"

• título: String

• description: Descrição HTML (etiquetas permitidas: br, ul, li)

• employmentType: NULL ou uma lista de "INTERN", "PERDIEM", "FULLTIME", "PARTTIME", "TEMPORARY", "VOLUNTEER", "CONTRACTOR" (ex.: ["FULLTIME", "PARTTIME"])

• salaryCurrency: NULL ou uma destas moedas "EUR", "CHF", "INR", "JPY", "USD"

• salaryValue: Número (por exemplo: 42.00)

• salaryUnit: NULL ou um destes "DAY", "HOUR", "WEEK", "YEAR", "MONTH"

• streetAndNo: String

• cidade: String

• postalCode: String (por causa dos zeros à esquerda)

• countryCode: Código de país i18n (por exemplo, "DE" ou "FR").

• companyName: Cadeiade caracteres

• companyLogoUrl: URL completo para um logótipo (250px x 250px, .png, .jpeg, .jpg)

• redirectUrl: URL completo para redirecionar após clicar no "Botão candidatar-se" no Google for Jobs.

Resposta (exemplo):

{
id: "2fd59d17-14ea-4b86-a3d8-c3126db5fbc6",
status: "PUBLISHED",
title: "SAP S/4HANA Senior Developer",
description: "Lorem ipsum dolor sit amet
consetetur ..."
...
}

CURL (Exemplo):

$curl - XPUT - H 'x-api-key: cca265e6-5c40-4187-a0e9-713b4a9c453f' - H "Content-type: application/json" - d '{title: "SAP S/4HANA Junior Developer",employmentType: ["FULLTIME"]}' 'https://app.seo-for-jobs.com/api/public/job/2fd59d17-14ea-4b86-a3d8-c3126db5fbc6'

DELETE /job/{id}

Elimina um anúncio de emprego com o correspondente {id}.

Parâmetro:

nenhum

Resposta (Exemplo):

{
status: "SUCCESS"
}

CURL (Exemplo):

curl - XDELETE - H 'x-api-key: cca265e6-5c40-4187-a0e9-713b4a9c453f' 'https://app.seo-for-jobs.com/api/public/job/2fd59d17-14ea-4b86-a3d8-c3126db5fbc6'

Erros

Se ocorrer um erro durante o processamento do seu pedido, receberá um dos seguintes códigos:

API_TOKEN_INVALID
O API Token fornecido não foi encontrado numa conta ativa. Uma conta é marcada como "ativa" quando tem um pacote ativo.

REQUEST_LIMIT_REACHED
O limite diário de pedidos foi atingido. O seu limite de pedidos será reposto numa janela deslizante de 24 horas.

UPGRADE_NECESSARY
A contagem total de trabalhos com o estado "PUBLISHED" atingiu o seu limite de pacotes. Actualize a sua conta para publicar mais tarefas.

ID_NOT_FOUND
O ID fornecido para um anúncio de emprego específico não foi encontrado.