Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Request credential

First time request

If you are not an API user yet, and plan to automate your file handling processed. Then please request an API credential from WMDA support team.

Update credential because of expiration

WMDA credential only available for one year currently. If your credential is expired, please send to support to request a new one. 
Currently, WMDA is implementing a new feature to let API user to request a new credential by themselves before the credential expires.

Refresh Bear Token

Using the REST API

To get more knowledge for usage of curl, we recommend member to read the doc for curl   https://ec.haxx.se/usingcurl-netrc.html

...

Step 1: Request the credential which can be used to generate the Bear Token from WMDA if you are not a API user yet. 

Step 2: Test to use the API in WMDA Data Manager.
            You can use the API doc in swagger: https://brave-forest-04a379103.azurestaticapps.net/?urls.primaryName=Data%20Manager%20Data%20Exchange%20API#/

...

If you are already familiar with the API  implementation, then you can skip Step 2, and test from your own implementation.In case the upload succeeded, an XML response with meta information of the upload is generated. You may use this for own logging purposes. For more info you can read the full API specification.


Below is an example to guide how to upload a file:

PUTstagingdatauploadv2io/ION1234/ION-1234-D.gpg
URL
SERVER URL

Staging sandbox system:  https://sansandbox-datamanager-datauploadapi.wmda.info

Production system:  https://datauploaddatamanager-api.wmda.info

URI

/api/v2v1/iofiles/ION1234/upload

Explanations: 

  • Please refer to the file naming convention.
    This  is stated as : For XML format: The files are marked with ION numbers ( ION-1234-D or ION-1234-C)
  • The ION number is the unique ION number of an organisation sending the file.
  • The D give the information that it is a donor file and the C give the information that it is a cord blood file
METHODPOST
Full URL path example

For donor for organization with ION-1234, the full path is as below:

https://

sandbox-datamanager-

api.wmda.info/api/

v1/

files/upload

Request form


HEADER

Authorization and Content-Type are required, the other ones are optional

AuthorizationbasicBear Token
Content-Type

application/octet-stream (when your file < 128K)

multipart/form-data (when your file >128K)

From  , Content-Type is required. 
See our suggestion below in "Upload".

cX-Rename-If-Existstrue

...


SAMPLE Request

First test the connection by using the right path and fetching the metadata : it should result in a response 200 OK.

...