Pastas

Manipulação de pastas para os arquivos

Você pode criar pastas nomeadas para organização dos documentos, dessa forma, ao fazer um upload de um arquivo, basta informar em qual pasta este documento deverá ficar.

Neste momento não é possível criar subpastas.

Criar pasta

POST https://api-v1.assine.online/v1/folder

Criação de uma nova pasta.

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Bearer <access-token>

Request Body

Name	Type	Description
name	string	Nome da pasta
path	string	Caminho virtual de localização pasta

201

{
    "id": 37,
    "name": "xpto",
    "path": "xpto",
    "businessUnit": null,
    "_embedded": {
   	 "user": {
   		 "id": 500,
   		 "name": "User 2",
   		 "username": "[e-mail]",
   		 "email": "[e-mail]",
   		 "_links": {
   			 "self": {
   				 "href": "https://api.assine.online/v1/user/500"
   			 }
   		 }
   	 }
    },
    "_links": {
   	 "self": {
   		 "href": "https://api.assine.online/v1/folder/37"
   	 }
    }
}

Com o ID da pasta criada, você pode utilizá-la quando criar o workflow informando a propriedade idFolder nas definições dos arquivos.

Listar pastas

GET https://api-v1.assine.online/v1/folder

Lista todas as pastas ou uma pasta filtrada.

Headers

Name	Type	Description
Authorization	string	Bearer <access-token>
Content-Type	string	application/json

200

{
    "_links": {
   	 "self": {
   		 "href": "https://api.assine.online/v1/folder?page=1"
   	 },
   	 "first": {
   		 "href": "https://api.assine.online/v1/folder"
   	 },
   	 "last": {
   		 "href": "https://api.assine.online/v1/folder?page=1"
   	 }
    },
    "_embedded": {
   	 "folder": [{
   			 "id": 36,
   			 "name": "My Favorite Path TI",
   			 "path": "/virtual/ti",
   			 "businessUnit": null,
   			 "_embedded": {
   				 "user": {
   					 "id": 500,
   					 "name": "User 2",
   					 "username": "[e-mail]",
   					 "email": "[e-mail]",
   					 "_links": {
   						 "self": {
   							 "href": "https://api.assine.online/v1/user/500"
   						 }
   					 }
   				 }
   			 },
   			 "_links": {
   				 "self": {
   					 "href": "https://api.assine.online/v1/folder/36"
   				 }
   			 }
   		 },
   		 {
   			 "id": 37,
   			 "name": "xpto",
   			 "path": "xpto",
   			 "businessUnit": null,
   			 "_embedded": {
   				 "user": {
   					 "id": 500,
   					 "name": "User 2",
   					 "username": "[e-mail]",
   					 "email": "[e-mail]",
   					 "_links": {
   						 "self": {
   							 "href": "https://api.assine.online/v1/user/500"
   						 }
   					 }
   				 }
   			 },
   			 "_links": {
   				 "self": {
   					 "href": "https://api.assine.online/v1/folder/37"
   				 }
   			 }
   		 }
   	 ]
    },
    "page_count": 1,
    "page_size": 25,
    "total_items": 2,
    "page": 1
}

Para buscar uma pasta de nome ou caminho específico:

curl -X GET https://api-v1.assine.online/v1/folder?filter[0][type]=eq&filter[0][field]=name&filter[0][value]=<nome-da-pasta>

Caso queira buscar pelo path e não pelo nome, basta trocar a query filter[0][field]=name por filter[0][field]=path .

Alterar pastas

PATCH https://api-v1.assine.online/v1/folder/:id

Altera o nome de pastas que o usuário criou

Headers

Name	Type	Description
Authorization*	String	Bearer <access-token
Content-Type	String	application/json

Request Body

Name	Type	Description
name*	String	Novo nome da pasta

200: OK

{
    "id": 317,
    "name": "Nova Pasta",
    "_links": {
        "self": {
            "href": "http://localhost/folder/317"
        }
    }
}

Remover pasta

DELETE https://api-v1.assine.online/v1/folder/:id

Remove pastas que o usuário criou.

Headers

Name	Type	Description
Authorization*	String	Bearer <access-token>
Content-Type	String	application/json

204: No Content

{
    // Response
}

Listar documentos de uma pasta

GET https://api-v1.assine.online/v1/document

Retorna os arquivos de uma pasta pelo ID da pasta.

Path Parameters

Name	Type	Description
filter[0][value]	string	ID da pasta
filter[0][field]	string	folder
filter[0][type]	string	eq

Headers

Name	Type	Description
Authorization	string	Bearer <access-token>
Content-Type	string	application/json

200

{
	"_links": {
    	"self": {
        	"href": "https://api.assine.online/v1/document?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=folder&filter%5B0%5D%5Bvalue%5D=89&page=1"
    	},
    	"first": {
        	"href": "https://api.assine.online/v1/document?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=folder&filter%5B0%5D%5Bvalue%5D=89"
    	},
    	"last": {
        	"href": "https://api.assine.online/v1/document?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=folder&filter%5B0%5D%5Bvalue%5D=89&page=48"
    	},
    	"next": {
        	"href": "https://api.assine.online/v1/document?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=folder&filter%5B0%5D%5Bvalue%5D=89&page=2"
    	}
	},
	"_embedded": {
    	"document": [
        	{
            	"id": 192,
            	"name": null,
            	"dateReceived": {
                	"date": "2019-08-12 17:32:05.000000",
                	"timezone_type": 3,
                	"timezone": "UTC"
            	},
            	"dateStatus": {
                	"date": "2019-08-12 17:32:05.000000",
                	"timezone_type": 3,
                	"timezone": "UTC"
            	},
            	"status": 0,
            	"file": null,
            	"_embedded": {
                	"folder": {
                    	"id": 89,
                    	"name": "default",
                    	"path": "default",
                    	"_links": {
                        	"self": {
                            	"href": "https://api.assine.online/v1/folder/89"
                        	}
                    	}
                	},
                	"originalFile": {
                    	"id": 2886,
                    	"name": "14064108_signed.pdf",
                    	"mimeType": "application/pdf",
                    	"description": "14064108_signed.pdf",
                    	"checksum": "03d14e83d6117d764b15189ced3f26061f856de2",
                    	"size": "195080",
                    	"uuid": "e2dvb2RfbG9va317ImRhdGEiOnsidXVpZCI6ImZjOTc3NmY4LWJkMjYtMTFlOS04MGU0LTAyNDJjMGE4NzAwNyJ9LCJobWFjIjoiYTI3NWE5M2Y4MmJjYWI3ODU5MjU5MDA4NDBhNGMwMDkzODk4YmE3N2M2MDQ4MTBiMDk1MGYxMmVhZGIxZjViNiIsIm5vbmNlIjoiNjU2MTE1NzIzNTkzNDIifQ==",
                    	"_links": {
                        	"self": {
                            	"href": "https://api.assine.online/file/2886"
                        	}
                    	}
                	},
                	"workflow": {
                    	"id": 186,
                    	"message": "TESTE",
                    	"status": 1,
                    	"dateCreated": {
                        	"date": "2019-08-12 17:32:05.000000",
                        	"timezone_type": 3,
                        	"timezone": "UTC"
                    	},
                    	"dateStatus": {
                        	"date": "2019-08-12 17:32:06.000000",
                        	"timezone_type": 3,
                        	"timezone": "UTC"
                    	},
                    	"dateFinished": null,
                    	"_links": {
                        	"self": {
                            	"href": "https://api.assine.online/v1/workflow/186"
                        	}
                    	}
                	}
            	},
            	"_links": {
                	"self": {
                    	"href": "https://api.assine.online/v1/document/192"
                	}
            	}
        	}
    	]
	},
	"page_count": 48,
	"page_size": 1,
	"total_items": 48,
	"page": 1
}

Mudar documento de pasta

PATCH https://api-v1.assine.online/v1/document/:id

Muda um documento da pasta de um usuário para outra do mesmo usuário.

Headers

Name	Type	Description
Authorization*	String	Bearer <access-token>
Content-Type	String	application/json

Request Body

Name	Type	Description
folder*	String	ID da pasta onde se deseja colocar o documento

200: OK

{
    "id": 1046,
    "_embedded": {
        "folder": {
            "id": 316,
            "name": "default",
            "path": "default",
            "_links": {
                "self": {
                    "href": "http://localhost/folder/316"
                }
            }
        }
    },
    "_links": {
        "self": {
            "href": "http://localhost/document/1046"
        }
    }
}

Compartilhar uma pasta

POST https://api-v1.assine.online/v1/folder-visibility

Permite que outro usuário veja o conteúdo da pasta. Esta funcionalidade está disponível para perfis de Conta Jurídica e só é possível dar permissão para usuários que fazem parte da organização.

Headers

Name	Type	Description
Authorization	string	Bearer <access-token>
Content0Type	string	application/json

Request Body

Name	Type	Description
type	number	0 - Todos da organização podem ver a pasta; 1 - Todos de um time podem ver a pasta (Ainda não implementado); 2 - O usuário especificado pode ver a pasta.
idFolder	number	ID da pasta que deseja compartilhar
idUser	number	Caso o "type" seja 2, informe o ID do usuário que terá a permissão de ver a pasta.

200

{
    "id": 23,
    "type": 2,
    "businessUnit": null,
    "team": null,
    "_embedded": {
        "user": {
            "id": 46,
            "name": "João Das Neves",
            "username": "[e-mail]",
            "email": "[e-mail]",
            "_links": {
                "self": {
                    "href": "https://api.assine.online/v1/user/46"
                }
            }
        }
    },
    "_links": {
        "self": {
            "href": "https://api.assine.online/v1/folder-visibility/23"
        }
    }
}

Esta visibilidade adicionada permite somente que o usuário veja os arquivos da pasta e faça download. Esta visibilidade não dá opção para o usuário(s) em questão ver o workflow completo do qual este arquivo pertence.

Listar compartilhamentos de uma pasta

GET https://api-v1.assine.online/v1/folder-visibility

Caso tenha criado permissões de visualização para uma pasta, você pode buscar todas as permissões ativas por esse endpoint.

Query Parameters

Name	Type	Description
filter[0][value]	number	ID da pasta
filter[0][type]	string	eq
filter[0][field]	string	folder

Headers

Name	Type	Description
Authorization	string	Bearer <access-token>
Content-Type	string	application/json

200

{
    "_links": {
        "self": {
            "href": "https://api.assine.online/v1/folder-visibility?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=folder&filter%5B0%5D%5Bvalue%5D=22&page=1"
        },
        "first": {
            "href": "https://api.assine.online/v1/folder-visibility?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=folder&filter%5B0%5D%5Bvalue%5D=22"
        },
        "last": {
            "href": "https://api-dev.assine.online/v1/folder-visibility?filter%5B0%5D%5Btype%5D=eq&filter%5B0%5D%5Bfield%5D=folder&filter%5B0%5D%5Bvalue%5D=22&page=1"
        }
    },
    "_embedded": {
        "folder_visibility": [
            {
                "id": 22,
                "type": 2,
                "businessUnit": null,
                "team": null,
                "_embedded": {
                    "user": {
                        "id": 45,
                        "name": "Jhon Doe",
                        "username": "[e-mail]",
                        "email": "[e-mail]",
                        "_links": {
                            "self": {
                                "href": "https://api.assine.online/v1/user/45"
                            }
                        }
                    }
                },
                "_links": {
                    "self": {
                        "href": "https://api.assine.online/v1/folder-visibility/22"
                    }
                }
            },
            {
                "id": 23,
                "type": 2,
                "businessUnit": null,
                "team": null,
                "_embedded": {
                    "user": {
                        "id": 46,
                        "name": "Fulano",
                        "username": "[e-mail]",
                        "email": "[e-mail]",
                        "_links": {
                            "self": {
                                "href": "https://api.assine.online/v1/user/46"
                            }
                        }
                    }
                },
                "_links": {
                    "self": {
                        "href": "https://api.assine.online/v1/folder-visibility/23"
                    }
                }
            }
        ]
    },
    "page_count": 1,
    "page_size": 25,
    "total_items": 2,
    "page": 1
}

A chamada da URL fica algo similar a:

curl -X GET https://api-v1.assine.online/v1/folder-visibility?filter[0][field]=folder&filter[0][type]=eq&filter[0][value]=<ID-DA-PASTA>

Remover compartilhamento de uma pasta

DELETE https://api-v1.assine.online/v1/folder-visibility/:id

Remove a visibilidade criada, lembrando que o ID não é equivalente a pasta nem ao usuário e sim o ID do relacionamento entre os dois, consulte em listar visibilidade para saber o ID de compartilhamento.

Path Parameters

Name	Type	Description
id	number	ID de compartilhamento

Headers

Name	Type	Description
Authorization	string	Bearer <access-token>
Content-Type	string	application/json

204

Note que não é possível remover a visibilidade do criador do fluxo da pasta em que o arquivo está, somente demais compartilhamentos.