Proposal Page - Documentação da API

Blocos

Criar

Você pode usar esse endpoint para criar um bloco.

  • Endpoint:
POST https://api.proposalpage.com/projects/<projectId>/blocks
1
  • Resposta:
Status: 201

{
  "style": {
    "backgroundColor": "rgba(255, 255, 255, 1)",
    "backgroundImage": "",
    "backgroundRepeat": "no-repeat",
    "backgroundSize": "cover",
    "backgroundPosition": "center center",
    "opacity": 1
  },
  "_id": "5c41db25d139900014b5d8ae",
  "description": "Block Last",
  "rows": [ rowSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  • Parâmetros:

    • Path: Vazio.

    • Cabeçalho:

    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo:
    Nome Tipo Descrição Requerido
    style object Estilo do bloco.
    description string Descrição do bloco. ✔️
    rows array Linhas do bloco.

  • Exemplo:

curl -XPOST -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "description": "New block", "rows": [] }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks'
1

Clonar

Você pode usar esse endpoint para clonar um bloco e colocá-lo em uma posição específica.

  • Endpoint:
POST https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/clone/<position>
1
  • Resposta:
Status: 201

{
  "style": {
    "backgroundColor": "rgba(255, 255, 255, 1)",
    "backgroundImage": "",
    "backgroundRepeat": "no-repeat",
    "backgroundSize": "cover",
    "backgroundPosition": "center center",
    "opacity": 1
  },
  "_id": "5c41db25d139900014b5d8ae",
  "description": "Block Last",
  "rows": [ rowSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto do bloco que será clonado. ✔️
    blockId string O id do bloco que será clonado. ✔️
    position número A posição para colocar o bloco que será clonado (por exemplo, 0 é o primeiro).
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.

  • Exemplo:

curl -XPOST -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/clone/0'
1

Deletar

Você pode usar esse endpoint para deletar um bloco.

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

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto do bloco que será deletado. ✔️
    blockId string O id do bloco que 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'
1

Listar

Você pode usar esse endpoint para listar os blocos de um projeto.

  • Endpoint:
GET https://api.proposalpage.com/projects/<projectId>/blocks
1
  • Resposta:
Status: 200

{
  [
    { ... },
    {
        "style": {
          "backgroundColor": "rgba(255, 255, 255, 1)",
          "backgroundImage": "",
          "backgroundRepeat": "no-repeat",
          "backgroundSize": "cover",
          "backgroundPosition": "center center",
          "opacity": 1
        },
        "_id": "5c41db25d139900014b5d8ae",
        "description": "Block Last",
        "rows": [ rowSchema ],
        "createdAt": "2019-01-18T13:56:53.742Z",
        "updatedAt": "2019-01-18T13:56:53.742Z"
    },
    { ... }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto que os blocos serão listados. ✔️
    • 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'
1

Mover para Trás

Você pode usar esse endpoint para mover um bloco para trás.

  • Endpoint:
POST https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/backward
1
  • Resposta:
Status: 200

{
  "style": {
    "backgroundColor": "rgba(255, 255, 255, 1)",
    "backgroundImage": "",
    "backgroundRepeat": "no-repeat",
    "backgroundSize": "cover",
    "backgroundPosition": "center center",
    "opacity": 1
  },
  "_id": "5c41db25d139900014b5d8ae",
  "description": "Block Last",
  "rows": [ rowSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto do bloco que será movido para trás. ✔️
    blockId string O id do bloco que será movido para trás. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.

  • Exemplo:

curl -XPOST -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/forward'
1

Mover para Frente

Você pode usar esse endpoint para mover um bloco para frente.

  • Endpoint:
POST https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/forward
1
  • Resposta:
Status: 200

{
  "style": {
    "backgroundColor": "rgba(255, 255, 255, 1)",
    "backgroundImage": "",
    "backgroundRepeat": "no-repeat",
    "backgroundSize": "cover",
    "backgroundPosition": "center center",
    "opacity": 1
  },
  "_id": "5c41db25d139900014b5d8ae",
  "description": "Block Last",
  "rows": [ rowSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto do bloco que será movido para frente. ✔️
    blockId string O id do bloco que será movido para frente. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.

  • Exemplo:

curl -XPOST -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/forward'
1

Atualizar

Você pode usar esse endpoint para atualizar um bloco.

  • Endpoint:
PUT https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>
1
  • Resposta:
Status: 200

{
  "style": {
    "backgroundColor": "rgba(255, 255, 255, 1)",
    "backgroundImage": "",
    "backgroundRepeat": "no-repeat",
    "backgroundSize": "cover",
    "backgroundPosition": "center center",
    "opacity": 1
  },
  "_id": "5c41db25d139900014b5d8ae",
  "description": "Block Last",
  "rows": [ rowSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto do bloco que será atualizado. ✔️
    blockId string O id do bloco que 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
    style object Estilo do bloco.
    description string Descrição do bloco.
    rows array Linhas do bloco.

  • Exemplo:

curl -XPUT -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "description": "Updated block description" }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae'
1

Recuperar

Você pode usar esse endpoint para recuperar um bloco.

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

{
  "style": {
    "backgroundColor": "rgba(255, 255, 255, 1)",
    "backgroundImage": "",
    "backgroundRepeat": "no-repeat",
    "backgroundSize": "cover",
    "backgroundPosition": "center center",
    "opacity": 1
  },
  "_id": "5c41db25d139900014b5d8ae",
  "description": "Block Last",
  "rows": [ rowSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto do bloco que será recuperado. ✔️
    blockId string O id do bloco que 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'
1
Editar essa página no GitHub
Última Atualização: 2019-5-14 17:46:47

← Linhas →