Proposal Page - Documentação da API

Conteúdos

Criar

Você pode usar esse endpoint para criar um conteúdo.

  • Endpoint:
POST https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents
1
  • Resposta:
Status: 201

{
    "_id": "5cb869d132f905001a024656",
    "type": "empty",
    "style": {
         "backgroundImage": "",
         "backgroundRepeat": "no-repeat",
         "backgroundSize": "cover",
         "backgroundPosition": "center center",
         "opacity": 1,
     }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto que o conteúdo vai ser criado. ✔️
    blockId string O id do bloco que o conteúdo vai ser criado. ✔️
    rowId string O id da linha da coluna que o conteúdo vai ser criado. ✔️
    columnId string O id da coluna de que o conteúdo vai ser criado. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo:
    Nome Tipo Descrição Requerido
    type string O tipo do conteúdo (empty, text, image, video or quote). ✔️
    style object O estilo do conteúdo.
    data object Os dados do conteúdo.

  • Exemplo:

curl -XPOST -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "type": "empty" }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents'
1

Deletar

Você pode usar esse endpoint para excluir um conteúdo.

  • Endpoint:
DELETE https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents/<contentId>
1
  • Resposta:
Status: 204 (no-content)
1

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto do conteúdo que será deletado. ✔️
    blockId string O id do bloco do conteúdo que será deletado. ✔️
    rowId string O id da linha do conteúdo que será deletado. ✔️
    columnId string O id da coluna do conteúdo que será deletado. ✔️
    contentId string O id do conteúdo a ser deletado. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.

  • Exemplo:

curl -XDELETE -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents/5cb869d132f905001a024656'
1

Listar

Você pode usar esse endpoint para listar o conteúdo de uma coluna.

  • Endpoint:
GET https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents
1
  • Resposta:
Status: 200

{
  [
    { ... },
    {
        "_id": "5cb869d132f905001a024656",
        "type": "empty",
        "style": {
             "backgroundImage": "",
             "backgroundRepeat": "no-repeat",
             "backgroundSize": "cover",
             "backgroundPosition": "center center",
             "opacity": 1,
         }
    },
    { ... }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto que o conteúdo será listado. ✔️
    blockId string O id do bloco que o conteúdo vai ser listado. ✔️
    rowId string O id da linha da coluna que o conteúdo vai ser listado. ✔️
    columnId string O id da coluna que o conteúdo vai ser listado. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.

  • Exemplo:

curl -XGET -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents'
1

Atualizar

Você pode usar esse endpoint para atualizar um conteúdo.

  • Endpoint:
PUT https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents/<contentId>
1
  • Resposta:
Status: 200

{
    "_id": "5cb869d132f905001a024656",
    "type": "empty",
    "style": {
         "backgroundImage": "",
         "backgroundRepeat": "no-repeat",
         "backgroundSize": "cover",
         "backgroundPosition": "center center",
         "opacity": 1,
     }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto do conteúdo que será atualizado. ✔️
    blockId string O id do bloco do conteúdo que será atualizado. ✔️
    rowId string O id da linha do conteúdo que será atualizado. ✔️
    columnId string O id da coluna do conteúdo que será atualizado. ✔️
    contentId string O id do conteúdo a ser atualizado. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo:
    Nome Tipo Descrição Requerido
    type string O tipo do conteúdo (empty, text, image, video or quote). ✔️
    style object O estilo do conteúdo.
    data object Os dados do conteúdo.

  • Exemplo:

curl -XPUT -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "type": "text", "data": {} }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents/5cb869d132f905001a024656'
1

Recuperar

Você pode usar esse endpoint para recuperar um conteúdo.

  • Endpoint:
GET https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/columns/<columnId>/contents/<contentId>
1
  • Resposta:
Status: 200

{
    "_id": "5cb869d132f905001a024656",
    "type": "empty",
    "style": {
         "backgroundImage": "",
         "backgroundRepeat": "no-repeat",
         "backgroundSize": "cover",
         "backgroundPosition": "center center",
         "opacity": 1,
     }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto do conteúdo que será recuperado. ✔️
    blockId string O id do bloco do conteúdo que será recuperado. ✔️
    rowId string O id da linha do conteúdo que será recuperado. ✔️
    columnId string O id da coluna do conteúdo que será recuperado. ✔️
    contentId string O id do conteúdo a ser recuperado. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.

  • Exemplo:

curl -XGET -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/columns/5cc0ac42003a7c001ab5c95a/contents/5cb869d132f905001a024656'
1
Editar essa página no GitHub
Última Atualização: 2019-4-29 10:37:27

← Descrição →