---
# System prepended metadata

title: Yube/Kenoby - (CITATC) Material para criação de integração pela LinkApi
tags: [integration, docs, api, yube]

---

---
tags: yube,docs,api,integration
---

# Yube/Kenoby - (CITATC) Material para criação de integração pela LinkApi

Acesse https://ajuda.yube.com.br/desenvolvedores para documentação introdutória e tutoriais sobre a API da Yube.

## Autenticação

Todas requisições a serem feitas na API da Yube exige o envio da "Personal Token" seguindo o padrão JWT, enviado a token no header seguindo o formato `authorization: Bearer <Personal Token>`.


Token de acesso:

```
"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJoaXZlIiwiZXhwIjo0Nzg0MTIwNzAwLCJpYXQiOjE2MzA1MjA3MDAsImlzcyI6ImhpdmUiLCJqdGkiOiI0ZjdhZjJkOC0wZDMxLTQ3MDgtYTlkMC02OTY2MDhmZGNlM2IiLCJuYmYiOjE2MzA1MjA2OTksInN1YiI6IlVzZXI6NjkwZWQ2OTUtYjI2Ni00NjQ2LWI2MzQtNTdlNTkwY2Y5ODJhIiwidHlwIjoiYWNjZXNzIn0.BbbeSCObJJJA69lYIwuTw-2PzJLlYkQ9KUu7t5WZuRNTijyV9Id_PlwWBv8p3zIUrmmOhRU9oYzGJWF-plG4gA"
```

Exemplo:

```shell=
curl --request POST \
  --url https://api.yube.com.br/ \
  --header 'Authorization: Bearer <Personal Token>' \
  --header 'Content-Type: application/json' \
  --data '{"query":"query Company($companyId: ID!) {\n  node(id: $companyId) {\n    id\n    __typename\n    ... on Company {\n      nickname\n      corporateName\n      processesTemplates {\n        ...processTemplateFragment\n#         documentsTemplates {\n#           ...documentTemplateFragment\n#         }\n        groups {\n          __typename\n          id\n          name\n        }\n      }\n#       groups {\n#         __typename\n#         id\n#         name\n#         processesTemplates {\n#           ...processTemplateFragment\n#         }\n#       }\n    }\n  }\n}\n\nfragment processTemplateFragment on ProcessTemplate {\n  __typename\n  id\n  templateId\n  category\n  title\n  description\n  insertedAt\n  updatedAt  \n}\n\nfragment documentTemplateFragment on DocumentTemplate {\n  __typename\n  id\n  documentName\n  isDefault\n  filledOnlyByUsers\n  templateId\n  updatedAt\n}\n","variables":{"companyId":"Q29tcGFuew92OGU4YTc0NC23YTUzLslNTgtODllNy1mZDYzNzQzNjhkZTU="},"operationName":"Company"}'
```

> Mais informações em https://ajuda.yube.com.br/desenvolvedores/autenticacao

## Dados Parametrizados na Yube

### StatusId

| id | nome |
| -----| -------- |
| U3RhdHVzOmIzYWEzNjQzLWY2M2ItNDhhNC04YWI1LTY3YjllNDhmYzBhMw== | Convidado |
| U3RhdHVzOjZkMDY5OWZmLWFiODItNGY5Zi04MjU5LWEwZWNhZDZhNWNiMQ== | Pronto |
| U3RhdHVzOjUzYWE2YjM2LWM1ODEtNGQ2Ny05NjFlLTJhMzIzYmI2ZThlYw== | Finalizado |
| U3RhdHVzOmI0NWUzYWNlLWQ1NTQtNGE0NC1iM2MxLTc4ZTkyOGVmYmQ5Zg== | Arquivado |
| U3RhdHVzOjVlOWRkYzQ0LTZiMWYtNDFhNi05ODZmLTIxMjU5MzZmMTUwMg== | Em Cadastro |


### Empresas/Filiais

| Empresa | ID |
| -------- | -------- |
| ICI VILLA LOBOS  | Q29tcGFueTowMWFlMmI5MS1kYjFiLTQwZmQtOGE5Zi00ZTNjOWZkYzgwMzE= |
|PIRAJÁ VILLA LOBOS|Q29tcGFueTowYWY0ZTQ3OC0wZWU5LTRjODktYmViNi1iZTFjNzUwYjVjZDA=|
|PIRAJÁ TAMBORÉ|Q29tcGFueTowYjg1YzE0MS0wZjJjLTQ4MTQtODZjYi02MTYxYzM2NzNlNDM=|
|ELETTRICA CENTRO|Q29tcGFueTowY2FlYzViZC01NGJkLTQ1MTMtOGNkMi00MDJlMjJhYWMwNzg=|
|ELETTRICA AUGUXTA (PAULISTA)|Q29tcGFueToxODVjYTUyNC0zZTBjLTRmY2ItOTAxZC1hZTU3NjdmZTY0YjE=|
|PIRAJÁ MORUMBI|Q29tcGFueToxOTZiNjA1MS1jN2FmLTQzNDUtYWU5Yy03ODEwMWYyYWIzZjc=|
|LC1|Q29tcGFueToxZGM2YjBhNi1mMzA1LTQwYTctYTUwMy0yNDZlNDdhNWY3NzU=|
|LC4|Q29tcGFueToyMzNlNGZmZS1hMDlmLTRkMmQtOTljYi01NzA2ZWNkMzk2NWE=|
|ELETTRICA PINHEIROS|Q29tcGFueToyYTc4M2Y4YS0zZDdhLTRhYzQtODRiNi1lZGI0ZWNjOGZiNGE=|
|ELETTRICA ALAMEDA CAMPINAS|Q29tcGFueToyYWE2Njk0MC03OTBlLTRjYjUtODk4Yy1hYmVjYmU3ZjhlYWY=|
|PIRAJÁ FARIA LIMA|Q29tcGFueToyZmM1Y2JhMS1lZmZmLTRiNDQtYmFkYy0yYThjMjIxZjVmYWM=|
|PIRAJÁ PRAINHA ITAIM|Q29tcGFueTozNzE0ODY5Ni1hYzQxLTRmYmItYmYyNS1iOGMyMjc2NWVkMjk=|
|ELETTRICA GUAICUI|Q29tcGFueTozYTY4NjdhMy05MTc4LTQwY2MtYWY1OC04OGZhYzhlMWI3MDQ=|
|BRAZ LUMINÁRIAS|Q29tcGFueTozZGU2YjFkYy03MDRmLTQzOTktODhkYi0zZDFkNTVkNzc1Yjk=|
|PIRAJÁ PAULISTA|Q29tcGFueTozZWRjOTViZi01MjZlLTQxMmUtOGIyZC0yMmYyZThlODYzMDA=|
|BRAZ QUINTAL PARAÍSO|Q29tcGFueTo1NDFhNTg0NC0yMDIxLTQyYzQtOWIyZC0xNWRmZmZlMDc1M2M=|
|BRAZ QUINTAL|Q29tcGFueTo2MWU0Y2NiNC1mN2I5LTRjOTAtOGQ1Ny0xYTAxOTJhY2Y5NzE=|
|BRAZ TATUAPÉ|Q29tcGFueTo2NjcyZjE4MC0zODhlLTRhMWUtYjFiNS01ODJjMTEyNjkzYWQ=|
|ASTOR JK|Q29tcGFueTo2N2IwZmQ5NC1iZWFiLTQ3MzEtOGI0Zi04M2NlZTBkZTc5ZDU=|
|BRAZ HIGIENOPOLIS|Q29tcGFueTo2ZjZiZWNmMi1mYTVjLTQ4Y2ItYjM2Mi00MGEzMGQ3ZTMzYjk=|
|PIRAJÁ ELDORADO|Q29tcGFueTo3NGVkNDNhYS1mZTg0LTQzOGItYTg5My0zY2Y5MzliNTUxNWM=|
|BRÁZ RIO|Q29tcGFueTo3YzEyZDY1Ny1mMWMxLTQ1ZmYtOWE2OS02MGRjYTZmMWFmMzE=|
|DEVORO|Q29tcGFueTo4MDc0ZGVmNi1kYjMzLTRlZDctYjdmYS1jOWFlODBjZDYzYTI=|
|PIRAJÁ ORIGINAL|Q29tcGFueTo4Mjg3NGE3Ny0wZGFhLTRmMTQtOTBmZC03ZWU5ZTkyY2YyODQ=|
|ASTOR OSCAR FREIRE|Q29tcGFueTo4NmZjOTdkMy0yZTg5LTQ3NDQtOGFhZi02NGFhZGY0ZjUzNDQ=|
|CIATC|Q29tcGFueTo4ZWVjYzVkNS1lZDMzLTRhZDAtYTNiMi03Njg0YTllZTI2Mjg=|
|BRAZ ROUXINOL|Q29tcGFueTo4ZjQxNzI5YS1mYjkxLTQxZjYtYTZjYS0xZGM1N2Y1YTRmYTE=|
|LC3|Q29tcGFueTo5YzE4OTAzZS03OTMwLTQ4ODAtYjUxMS05YjFkMTk4YTgwNzg=|
|BRAZ PINHEIROS|Q29tcGFueTpiMzJiZGU5OS02MTQwLTRiODctODA5NS1mMzIwNjViNjVlNzA=|
|LC2|Q29tcGFueTpiOGZlMDQ3Yi02ZDYwLTQ4MGItODkyNC1iYzAyNGM4NTI2MjQ=|
|BRAZ MOEMA|Q29tcGFueTpjNjEyYzMwMy1jYTBkLTRhYmQtOWFiZS0zNzgyYTExMjlmZTY=|
|ELETTRICA VILA LEOPOLDINA|Q29tcGFueTpkNTI5ZWQ0OS1kMGQ3LTQ0MDctYTAzZC1lNjdmODUxOTUzMmE=|
|ICI JK|Q29tcGFueTpkNTY5NGFiMC02NGFlLTRhNmUtYTcxMi0wMjJlMTYwZmM1NDg=|
|BRÁZ TRATORIA|Q29tcGFueTpkOWVkZDNkMi1kM2MyLTQzOTItYWY3OS1hNmQwNTQwOTUwOGY=|
|ICI BELA CINTRA|Q29tcGFueTpkZGZkNWVkMy1lOGJlLTRhNjMtODg2MC0wMjNlMzk3ZjYwYjc=|
|BRAZ PERDIZES|Q29tcGFueTplOGRlOWU5OC0yMzdmLTQwODItOTBmMi04ZjVmZWNiZTVjZTQ=|
|BAR DO COFRE|Q29tcGFueTplYjQ2YTlmOS1kNWM0LTQwNmMtOWU3Ni0yNzlmYWMxYmJlNzA=|
|ASTOR SP|Q29tcGFueTplYzA5YjNlNS1jOWU1LTQ3ZTctOTFjZi02NWExMWIxNTIwOGY=|
|BRAZ CAMPINAS|Q29tcGFueTpmNjkxMzMwZS1kYjllLTQ2ZDItYmNhMy1mNjZhZGRiNWM2MDg=|
|ELETTRICA PERDIZES|Q29tcGFueTpmNjk5MmI2ZS00ZTQzLTRjNTYtYjdmMC0xNjhhNzUxZDZiNzA=|
|PIRAJÁ PRAINHA|Q29tcGFueTpmOWE1M2U3Mi00NjY4LTQ3MjUtOWJkOS0wYmM4MzM0OTNiNDE=|
|LC6|Q29tcGFueTpmOWMzZjk4ZS00OTAzLTQzZjQtOWJjNS0yZTk0ZGJjY2Y1Yjc=|
|PIRAJÁ ALPHAVILLE|Q29tcGFueTpmYjk2YjQwYi1kZDFkLTRkZjYtOGEzZS05NWU4N2FmM2UyMTk=|

### ProcessTemplate e Processo

Na Yube, ProcessTemplates são as entidades responsáveis por agrupar a documentação e determinar que tipo de documentação vai ser enviada para preenchimento pelo colaborador e alguns casos também pelo RH.

Tipos de ProcessTemplates:
- ADMISSION: Lista de documentação relacionadas a admissão do Colaborador.
- BENEFITS: Lista de documentação relacinoadas aos benefícios do Colaborador.

Os ProcessTemplate's são as informações enviadas a serem enviadas


> ATENÇÃO: O `id` da entidade **ProcessTemplate** pode mudar a cada ajuste feito na parametrização do setup do cliente. Sendo assim, a Yube recomenda que a LinkAPI utilize o `templateId` nas configurações do "De/Para", e no momento da criação do **Convite** busque o `id` do **ProcessTemplate** atualizado.


#### Processos de **Admissão**

> Regra padrão: Pode ser mais de 1, mas normalmente é apenas 1.

| Categoria | Título                            | templateId                                                               | id                                                                       |
| --------  | --------                          | --------                                                                 | --------                                                                 |
| ADMISSION | Admissão Estagiário  | UHJvY2Vzc1RlbXBsYXRlOjI5NzFhZTBlLTc0ZmUtNDQ3YS05YWM2LTc1YWM1MzVlMTU4Zg== | UHJvY2Vzc1RlbXBsYXRlOjYwNjI2NjAyLTk2NDYtNDUwNC1hZTJkLWZmMzQ0NGNmM2JmNw==  |
| ADMISSION | Admissão Jovem Aprendiz  | UHJvY2Vzc1RlbXBsYXRlOjNjNTRmNWQxLTdmZWItNGM4Ny04ZTNjLTU2YjZkMzRlYmM2Yw== | UHJvY2Vzc1RlbXBsYXRlOmUyMTc3NDU5LTc5MDEtNGFhNC04ODQ2LThiNGU3ZGJkMDc1ZQ==  |
| ADMISSION | Admissão TI / Manutenção  | UHJvY2Vzc1RlbXBsYXRlOmI0NWU5MTEwLWIxY2ItNDg5YS1hMmI4LWU5ZjI2ZmNhNGI1Mw== | UHJvY2Vzc1RlbXBsYXRlOjE5NzQwYmQ3LTc1MzMtNGZjNS04ZDQzLWY5ZTMwNzE4Y2I1ZA==  |
| ADMISSION | Admissão Padrão  | UHJvY2Vzc1RlbXBsYXRlOmI4ZDMyNmZlLTI3NDctNDQxYi04NGZkLTVkMzk4NjBkMjUwNQ== | UHJvY2Vzc1RlbXBsYXRlOmJhMzM5Y2M1LTQ5NzQtNGY4Ni1hOTQxLWJjMDljMWJhNWJhZQ==  |
| ADMISSION | Admissão Estrangeiro  | UHJvY2Vzc1RlbXBsYXRlOmU3MjFiZTg4LTIxNGQtNGRhMC1iODg3LWZmODVjZDhkYTFlNA== | UHJvY2Vzc1RlbXBsYXRlOjFjYTUwZjkyLTQwNTYtNDdjMi1iZWYwLWJkZTk4NTVkYWY5MA==  |


#### Processos de **Benefícios**

> Regra padrão: Pode ser mais de 1

| Categoria | Título                            | templateId                                                               | id                                                                       |
| --------  | --------                          | --------                                                                 | --------                                                                 |
| ADMISSION | Benefícios Gerente / Coordenador CIATC  | UHJvY2Vzc1RlbXBsYXRlOjE0NzI4ZTAzLTc1OTktNDUxZC1hNTQyLTQ5Mzc1ZjU2ZjBkNg== | UHJvY2Vzc1RlbXBsYXRlOmRiNTg2ZjhlLWFkYTYtNDQwNy1hMDc3LTg4OWVhZjJmODYxNw==  |
| ADMISSION | Benefícios CIATC  | UHJvY2Vzc1RlbXBsYXRlOjJmNDM3YjA2LWQ2ZDEtNDk2OS1iMzAyLWJkOTE5MDk3M2M1NA== | UHJvY2Vzc1RlbXBsYXRlOjczMTM1NDU1LWQxOWUtNGM2Zi05MWQwLWJlMDdmZGI5MDY2Mg==  |
| ADMISSION | Benefícios Estagiários  | UHJvY2Vzc1RlbXBsYXRlOjRkOWNkY2FlLTQ5MjMtNGMzOC05Y2U2LWI3ZTA0ZGU2MmZhYQ== | UHJvY2Vzc1RlbXBsYXRlOjI2MTE0ZDJkLTEyYzctNDg1OS1iZTlhLWNmMzEyNzZiMjczOA==  |
| ADMISSION | Benefícios Gerente / Coordenador Loja  | UHJvY2Vzc1RlbXBsYXRlOjYyYmFmN2QyLTYwMzgtNDI0ZS1iYTcyLWI0MjAwMmE1ZWQwMQ== | UHJvY2Vzc1RlbXBsYXRlOmE4NzVkN2ExLTRiOTItNGJkYS04MDA1LWQ3MDJiZDdkOWQyZQ==  |
| ADMISSION | Benefícios Loja - Lojas Rio  | UHJvY2Vzc1RlbXBsYXRlOjY0NmQ5YzNhLWIyNjctNDdmYS04YjhmLTIxNjBiZjAyMTU2OA== | UHJvY2Vzc1RlbXBsYXRlOjExNWZkNjQ0LWIxZTUtNGJjZC04YzViLTU2OTU0NzkxYzZiYg==  |
| ADMISSION | Benefícios Diretores  | UHJvY2Vzc1RlbXBsYXRlOjZkN2U3ZGE3LTgzNWMtNDg2MS05NzU3LTdkNTBmZWJkNWFkZQ== | UHJvY2Vzc1RlbXBsYXRlOmIwNGQyODE4LTZkODgtNDBkZi05NGM0LWZkNDViNTU1Yjk1MQ==  |
| ADMISSION | Benefícios Loja - Demais Localidades  | UHJvY2Vzc1RlbXBsYXRlOmEyOTZjMDIzLWE5ZWItNDRjYS05Y2FjLWE0NTI1Zjk3ODVlNw== | UHJvY2Vzc1RlbXBsYXRlOjkzYWE3Y2MwLWZhZGEtNGY0NC05ODczLTg1MDEzNGZmYWNiYQ==  |
| ADMISSION | Benefícios Loja - Alphaville / Campinas  | UHJvY2Vzc1RlbXBsYXRlOmIwOGQ2OWNjLTBmNjAtNGIxNS05NDJkLTI2NDRhOGM0YTVlZg== | UHJvY2Vzc1RlbXBsYXRlOmUzMTliZmViLTk2YzYtNDg4Mi04YmI2LWI5ZjkzYzJkODM3Nw==  |
| ADMISSION | Benefícios Jovem Aprendiz  | UHJvY2Vzc1RlbXBsYXRlOmRhYWM3ZDFmLTJmYmQtNGM3NC05M2FlLTVhMDg0MTVmYTc4Yw== | UHJvY2Vzc1RlbXBsYXRlOjcxNzdkNjk0LTg5NmEtNDAzMC04MGY0LTQwZTEyMTY1NzhiZA==  |
| ADMISSION | Benefícios TI / Manutenção  | UHJvY2Vzc1RlbXBsYXRlOmRmZjQ0NTcxLWFkODgtNDY2Mi05Y2Q4LTIxYzk2OWFjYjc0OQ== | UHJvY2Vzc1RlbXBsYXRlOjczM2NhYTY3LTBiNDctNDlhYS1iMTEwLWI2Y2U4ZTc0YmFkMQ==  |

#### Processos de **dependentes**

> Regra padrão: Sempre enviar todos

| Categoria | Título                            | templateId                                                               | id                                                                       |
| --------  | --------                          | --------                                                                 | --------                                                                 |
| DEPENDENT | Dependente: Filho entre 15 a 24 anos  | UHJvY2Vzc1RlbXBsYXRlOjU4NTAzMDVkLWIxODgtNGViMi05OTllLWE2ZWExZTgwNGE0Mw== | UHJvY2Vzc1RlbXBsYXRlOjQ1ZDY2OTE4LWZlOGItNGQzYi04ZjU1LTM5MzRlM2E0ODFmOA==  |
| DEPENDENT | Dependente: Filho entre 6 e 14 anos  | UHJvY2Vzc1RlbXBsYXRlOjc2ZDdlMTEzLTc4MWItNDRmNS04OTJlLWE2MDY2MWViOTZhOA== | UHJvY2Vzc1RlbXBsYXRlOjVlMDkwYTFiLWFhMzAtNDJmMS04NTE0LTQ5NDU3NTgwZjNmMA==  |
| DEPENDENT | Dependente: Cônjuge  | UHJvY2Vzc1RlbXBsYXRlOmExYjRlYTg0LWI5MWUtNGQzMi04ZWNlLTgzYjM2YzBjMTEzMQ== | UHJvY2Vzc1RlbXBsYXRlOjczYzY3MmI1LWU0MzQtNDc2OS05ODE4LWVjOGVkNTgzYTM5YQ==  |
| DEPENDENT | Dependente: Filho de 0 até 5 anos  | UHJvY2Vzc1RlbXBsYXRlOmRmMWU0Y2UwLWVjZTUtNDk5NS04MjJiLWNhNTUzNzQzZDA1MA== | UHJvY2Vzc1RlbXBsYXRlOmFkMTNjYjc4LTczYzYtNDAxZi1iNDk1LWIyMDNhYzA0MzBhYg==  |

## Criando Convites

A criação de **Convites** é o fluxo de inicialização da Admissão dos **Colaboradores** selecionados dentro da plataforma da Yube.

### Dados do Convite

Para a criação de 1 ou mais convites é necessário o envio das seguintes informações:

| Campo | Tipo do dado | Obrigatório | Descrição |
| ---   | ---          | ---         | ---     |
| companyId            | ID!                    | sim | Id da Empresa que o colaborador fará a admissão. |
| dueDate              | Date                   | não | Data limite para envio da documentação. ex: `2021-06-01` |
| referenceCode        | String                 | não | Código de referências externa. Recomendação: Id do colaborador na plataforma Kenoby |
| invitees             | [InputInvited!]!       | sim | Lista de colaboradores que a serem admitidos. Veja [Dados do Colaborador](#Dados-do-Colaborador) |
| processesTemplates   | [ID]                   | sim | Lista de id dos ProcessTemplate's a serem solicitados ao Colaborador |
| statusId             | ID!                    | sim | Status inicial do convite. Usar sempre `<STATUS ID>` |
| notificationChannels | [NotificationChannel!] | sim | Sempre utilizar `["EMAIL"]` |

> ATENÇÃO 1: Apenas colaboradores que irão receber a mesma lista de `processesTemplates` podem ser enviados juntos na criação do Convite. 
> ATENÇÃO 2: Não enviar mais que 20 colaboradores por criação de Convite.

### Dados do Colaborador

| Campo | Tipo do dado | Obrigatório | Descrição |
| ---   | ---          | ---         | ---     |
| email        |  String! | sim | Email do colaborador |
| mobilePhone  |  String! | sim | Número de celular |
| name         |  String! | sim | Nome do colaborafor |

> Exemplo de request para criação de convite em  https://ajuda.yube.com.br/desenvolvedores/criando-convites

### A listagem de ProcessTemplates

Para buscar a listagem de `ProcessTemplate`'s disponível para a Empresa utilize a query e variables a seguir:

```graphql=
query Company($companyId: ID!) {
  node(id: $companyId) {
    id
    __typename
    ... on Company {
      nickname
      corporateName
      processesTemplates {
        ...processTemplateFragment
      }
    }
  }
}

fragment processTemplateFragment on ProcessTemplate {
  __typename
  id
  templateId
  category
  title
  description
  insertedAt
  updatedAt  
}
```

Variables

```json=
{
  "companyId": "<ID da Empresa>"
}
```
