With our API for our SafeSign-module, it is possible to forward documents for signature directly from one’s private system or platform using NemID, touch-signing or by clicking the checkbox, hereby accepting the insertion of your signature.
With our API for our SafeShare-module, it is possible to forward end-to-end encrypted messages and/or files directly to all types of e-mail accounts using one’s private system or platform.
\nWEBLINKS
\nAPI Documentation: https://api.safeolio.dk/
\nTest domain: https://safesign.safeshare.dk
\nTest API: https://safesign.safeshare.dk/api/v1/
Used to check the users’ log-in information.\n
\nWe recommend only using this call to check the users’ log-in information. Additional calls are authenticated with every request.
With all API calls, Basic Authentication is used for the purpose of gaining the users’ approval.
\nAll requests need to include “Authorization” in the call.
\nThe user’s e-mail account is used as the username. Additionally, the user’s password for the account needs to be stated.
\nPlease note that the password needs to be MD5 encoded.
\nWe recommend the users’ e-mail account (username) and password is stored in the user’s own database. We also recommend using “check user auth” the first time the user is logged on in order to check log-in information.
Receiver’s email
\n","key":"email","type":"text","value":""},{"description":"Code for opening the message
\n","key":"security_code","type":"text","value":""},{"description":"Write the message for the receiver
\n","key":"message","type":"text","value":""},{"description":"Include files as attachments if you wish to send files
\n","key":"filet[]","type":"file","value":null,"disabled":true},{"description":"Fill out if you wish to send a text message
\n","key":"RecPhone","type":"text","value":"","disabled":true},{"description":"Email or Link (Email = Mail being sent from SafeShare)
\n","key":"sending_type","type":"text","value":"","disabled":true},{"description":"External ID (*)
\n","key":"sj_uid","type":"text","value":""}]},"url":"https://safesign.safeshare.dk/api/v1/sendMessageSafe","description":"This POST request is being used when creating a transmission that is being forwarded through SafeShare.
\nemail – this section is for writing the receiver’s email address.
\nsecurity_code – write the code, the receiver will be given to open the forwarded message**.
\nmessage – write the message, the receiver will be getting.
\nfilet[] – this section should only be filled out if you need to include files as attachments. Otherwise, the message will simply be sent.
\nRecPhone – this section should only be filled out if a text message is to be send.
\nsending_type – this section includes the email (SafeShare) or link that the message is sent from. If field is \"Mail\", a mail is sent.
\nsj_uid – this section shows the identifier’s information for future transmissions.
The GET request is used for retrieving information about a transmission, including whether the transmission has been unlocked by the receiver.\n
\nThis should be used in two different ways:
Unique identifier (UID)
\n","type":"text/plain"},"key":"sent_id","value":""},{"description":{"content":"detail = Detail.
\n","type":"text/plain"},"key":"type","value":"detail"}],"variable":[]}},"response":[{"id":"01881906-e063-4c63-909f-1622d83798a9","name":"Example response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://safesign.safeshare.dk/api/v1/GetMessages?sent_id=1&type=detail","protocol":"https","host":["safesign","safeshare","dk"],"path":["api","v1","GetMessages"],"query":[{"key":"sent_id","value":"1","description":"File main id to get info"},{"key":"type","value":"detail","description":"detail = Detail.\nfiles = files"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 04 Sep 2020 17:01:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"X-Powered-By","value":"PleskLin"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Basic realm=\"REST API\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": \"200\",\n \"status\": \"success\",\n \"data\": {\n \"file_main_id\": \"1\",\n \"status\": \"Not Open\",\n \"add_date\": \"1599234978\",\n \"code_sent_time\": \"1599234978\",\n \"opentime\": \"0000-00-00 00:00:00\",\n \"SenderID\": \"6259\",\n \"if_personal\": \"0\",\n \"remind_days\": \"2\",\n \"amount_per_mail\": \"0\",\n \"shipment_title\": \"Titel tiel\",\n \"sign_type\": \"dialog\",\n \"sj_uid\": \"300\"\n }\n}"}],"_postman_id":"a30a7290-27c9-4307-a0dd-6ffd6b6f9ae9"}],"id":"3a060215-a61a-4e09-a8ee-c0ce5831509d","description":"With our API for our SafeShare-module, it is possible to forward end-to-end encrypted messages and/or files directly to all types of e-mail accounts using one’s private system or platform.
\n","_postman_id":"3a060215-a61a-4e09-a8ee-c0ce5831509d"},{"name":"SafeSign","item":[{"name":"Send a SafeSign transmission","id":"78504174-c52c-4206-a551-557060e24e4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Fill out if you wish to secure the message with a code
\n","key":"security_code","type":"text","value":"","disabled":true},{"description":"Write the message for the receiver (*)
\n","key":"message","type":"text","value":""},{"description":"Include files for signing as attachments (*)
\n","key":"file[]","type":"file","value":null},{"description":"Include a text message for each signer (Yes / empty)
\n","key":"send_pass","type":"text","value":"","disabled":true},{"description":"Remind_days (*)
\n","key":"intervals","type":"text","value":""},{"description":"Include the title for the shipment (*)
\n","key":"shipment_title","type":"text","value":""},{"description":"Signature through touch, nemid or dialog (*)
\n","key":"sign_type","type":"text","value":""},{"description":"External ID
\n","key":"sj_uid","type":"text","value":""},{"description":"Can be used to send your own HTML formatted text to replace text in mail. If you do not include any text in this section, the default message is being used.
\n","key":"message_lst","type":"text","value":"","disabled":true},{"description":"Write signers in json format ex: [{\"name\":\"Matias Aabye\",\"email\":\"matias@proteq.nu\",\"tel\":\"31535496\"}]
\n","key":"signer_person","type":"text","value":""},{"description":"The number of signers
\n","key":"signers","type":"text","value":""},{"description":"The name of the company or person that is included in the default message
\n","key":"company_name","type":"text","value":"","disabled":true},{"description":"Enter date in the following format: yyyy-dd-mm
\n","key":"expiredate","type":"text","value":""}]},"url":"https://safesign.safeshare.dk/api/v1/SendMessageSafeSign","description":"This POST request is being used when creating a transmission that is being forwarded for signature through SafeSign and are being forwarded to the signers.\n
The default mails in this procedure is:
main_file_id
\n","key":"main_file_id","type":"text","value":""},{"description":"Types of functions
\n","key":"function","type":"text","value":""}]},"url":"https://safesign.safeshare.dk/api/v1/SafeSignFunctions","description":"The POST request is being used when deleting a transmission, receiving information about the document(s) in question and receiving the URL to the document(s).
\nFunction supports the following types:
\ncancel = stops the current order and deletes everything
\nfileinfo = get information about the SUV files
\nfileurl = get the URL for the direct file
This GET request can be used for retrieving general information about a transmission, such as who the transmission has been sent to, which documents have been attached etc.
\nThis should be used in two different ways:
Unique identifier (UID)
\n","type":"text/plain"},"key":"sent_id","value":""},{"key":"type","value":""}],"variable":[]}},"response":[{"id":"08bf7037-9498-4522-9e36-1fa8df15d92a","name":"Example response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://safesign.safeshare.dk/api/v1/GetMessages?sent_id=1&type=detail","protocol":"https","host":["safesign","safeshare","dk"],"path":["api","v1","GetMessages"],"query":[{"key":"sent_id","value":"1","description":"File main id to get info"},{"key":"type","value":"detail","description":"detail = Detail.\nfiles = files"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 04 Sep 2020 17:01:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"X-Powered-By","value":"PleskLin"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Basic realm=\"REST API\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": \"200\",\n \"status\": \"success\",\n \"data\": {\n \"file_main_id\": \"1\",\n \"status\": \"Not Open\",\n \"add_date\": \"1599234978\",\n \"code_sent_time\": \"1599234978\",\n \"opentime\": \"0000-00-00 00:00:00\",\n \"SenderID\": \"6259\",\n \"if_personal\": \"0\",\n \"remind_days\": \"2\",\n \"amount_per_mail\": \"0\",\n \"shipment_title\": \"Titel tiel\",\n \"sign_type\": \"dialog\",\n \"sj_uid\": \"300\"\n }\n}"}],"_postman_id":"fe01f6ec-754c-420f-882f-38fc622a62f3"},{"name":"Receive signer status","id":"0a1c238f-b063-48f2-aec6-af84f1a7a710","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The GET request is being used for retrieving information about whether the transmission has been signed and by whom.
\nPlease note that this requires file_main_id that can be returned by transfer functions.
\nWe recommend that you combine the status and signing details in order to combine transfer functions and signer status.
\nThe transmission has been signed if the status has been set to 1.
File_main_id
\n","type":"text/plain"},"key":"file_main_id","value":""}],"variable":[]}},"response":[{"id":"4a768104-84dc-4d95-9163-0136b6b347af","name":"Missing parameters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://localhost/safesign/api/v1/GetMessages/signerinfo?file_main_id=","protocol":"https","host":["localhost"],"path":["safesign","api","v1","GetMessages","signerinfo"],"query":[{"key":"file_main_id","value":"","description":"File_main_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Sep 2020 17:04:24 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.4.4"},{"key":"X-Powered-By","value":"PHP/7.4.4"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Set-Cookie","value":"ci_session=dra1jnpgt475q7u7qgvun6ig5rbgsfm4; path=/; HttpOnly"},{"key":"WWW-Authenticate","value":"Basic realm=\"REST API\""},{"key":"Content-Length","value":"89"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": \"400\",\n \"status\": \"error\",\n \"error_message\": \"Bad Request, missing external ID\"\n}"},{"id":"68b3e144-e4ea-4342-a734-c1123ed70251","name":"Response example","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://localhost/safesign/api/v1/GetMessages/signerinfo?file_main_id=88","protocol":"https","host":["localhost"],"path":["safesign","api","v1","GetMessages","signerinfo"],"query":[{"key":"file_main_id","value":"88"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 04 Sep 2020 15:04:32 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.4.4"},{"key":"X-Powered-By","value":"PHP/7.4.4"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Basic realm=\"REST API\""},{"key":"Content-Length","value":"287"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": \"200\",\n \"status\": \"succes\",\n \"data\": {\n \"signers\": [\n {\n \"status\": \"0\",\n \"link_expiry_date\": \"2020-10-24\",\n \"name\": \"Matias Aabye\",\n \"email\": \"matias@proteq.nu\",\n \"phone\": \"31535496\"\n },\n {\n \"status\": \"0\",\n \"link_expiry_date\": \"2020-10-24\",\n \"name\": \"Matias Jensen\",\n \"email\": \"Kontakt@proteq.nu\",\n \"phone\": \"0\"\n }\n ]\n }\n}"}],"_postman_id":"0a1c238f-b063-48f2-aec6-af84f1a7a710"},{"name":"Receive the signed document/file","id":"4d4d5d91-b68a-40b0-a57b-55c0cf8ee315","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"fileurl
\n","key":"function","type":"text","value":"","disabled":true}]},"url":"https://safesign.safeshare.dk/api/v1/SafeSignFunctions/ViewFile?key_id=","description":"Receive the signed document/file by base64_encoded value. \n
You can use the message functions to gain the direct URL.\n
You can use file_get_content to gain or download the file.
\nA case in point is curl, for downloading a file directly:
$url = 'https://safesign.safeshare.dk/api/v1/SafeSignFunctions/ViewFile?key_id='.$keyid;\n\n $ch = curl_init();\n curl_setopt($ch, CURLOPT_URL, $url);\n curl_setopt($ch, CURLOPT_USERPWD, $username . \":\" . $password);\n curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);\n curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);\n curl_setopt($ch, CURLOPT_TIMEOUT, 10);\n curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);\n curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);\n\n $result = curl_exec($ch);\n curl_close($ch);\n\n header('Cache-Control: public');\n header('Content-type: application/pdf');\n header('Content-Disposition: attachment; filename=\"'.$filename.'\"');\n header('Content-Length: '.strlen($result));\n echo $result;\nfile_sub_id
\n","type":"text/plain"},"key":"key_id","value":""}],"variable":[]}},"response":[{"id":"b4d52f72-f95a-40fe-9d06-30e117b5c666","name":"Missing ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://safesign.safeshare.dk/api/v1/SafeSignFunctions/ViewFile?key_id=","protocol":"https","host":["safesign","safeshare","dk"],"path":["api","v1","SafeSignFunctions","ViewFile"],"query":[{"key":"key_id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 04 Sep 2020 17:02:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"WWW-Authenticate","value":"Basic realm=\"REST API\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": \"400\",\n \"status\": \"error\",\n \"error_message\": \"Missing parameter\",\n \"details\": \"Missing ID\"\n}"}],"_postman_id":"4d4d5d91-b68a-40b0-a57b-55c0cf8ee315"}],"id":"4de4ea31-114d-47ff-918f-2686d8008a64","description":"With our API for our SafeSign-module, it is possible to forward documents for signature directly from one’s private system or platform using NemID, touch-signing or by clicking the checkbox, hereby accepting the insertion of your signature.
\n","_postman_id":"4de4ea31-114d-47ff-918f-2686d8008a64"}],"event":[{"listen":"prerequest","script":{"id":"a09e6888-dbf3-43a2-814e-f676a56d6677","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"58bcfddf-27ed-4e91-8fe7-66e460169fbf","type":"text/javascript","exec":[""]}}]}