Authentication
edeXa.com's blockchain file and folder functionality is accessible not only via the web interface but also through API interaction. To start using our API, you need to create an account and obtain the necessary credentials.
tip
MAINNET BASEURL
https://api-edexagw.edexa.com/bshare
TESTNET BASEURL
https://api-edexagw.io-world.com/bshare
Authenticate User
POST authenticate
This endpoint is used to authenticate with our service. After registration, users receive a client ID and secret key, both required for authentication.
If you're already registered, you can retrieve your API credentials here:
https://accounts.io-world.com
client-id is
required
.secret-key is
required
.The Authorization token will be
valid
for7 days
.
POST: Authenticate User
cURL
curl --location -g --request POST 'https://api-edexagw.io-world.com/bshare/api/authenticate' \
--header 'client-id: <CLIENT ID>' \
--header 'secret-key: <SECRET KEY>'
Parameters
Key | Value/Type | Description |
---|---|---|
clientId | `67809********************8` | An string |
Secret key | `789zbh**************8` | An string |
Responses
200: OK
{
"status": 200,
"message": "Logged in successfully",
"data": {
"token": "eyJhbG***********.eyJzdWIiOiJVMkZzZE***********************",
"name": "",
"userName": "",
"email": "j.*****@gmail.com",
"status": "active",
"profilePicture": "",
"cropProfilePicture": "",
"loginType": "normal",
"parentFolderId": "667bbe************"
}
}
404: Not Found
{
"status": 404,
"message": "User Not Found"
}
500: Not Found
{
"status": 500,
"message": "Something went wrong, please try again"
}
Enroll Organization
POST enroll
- External organizations must enroll with the blockchain to obtain a public address.
- You will receive the public address in the response.
- You must pass your
Bearer Token
via the Authorization parameter in the headers.
Enroll Organization
cURL
curl --location -g --request POST 'https://api-edexagw.io-world.com/bshare/api/enroll' \
--header 'Authorization: Bearer token' \
--header 'Content-Type: application/json' \
--data-raw '{
"userId": "16308************",
"email": "j*****@gmail.com"
}'
Parameters
Key | Value/Type | Type | Description |
---|---|---|---|
userId | String | String | Enter your user ID. |
String | String | Enter your valid email address. |
Responses
200: Success
{
"status": 201,
"message": "User created successfully",
"data": {
"folderId": "667e41******************"
}
}
401: Unauthorized
{
"status": 401,
"message": "Invalid auth token"
}
500:Internal Server Error
{
"status": 500,
"message": "Something went wrong, please try again"
}
Delete Organization
DELETE organization
- External organization must enrolled with blockchain to get public address
- In response user will get public address
- You have to pass your
Bearer Token
via the Authorization parameter through the headers.
Delete Organization
cURL
curl --location -g --request DELETE 'https://api-edexagw.io-world.com/bshare/api/organization' \
--header 'Authorization: Bearer token' \
--header 'Content-Type: application/json' \
--data '{
"userId": "Enter the organization id which you want to delete"
}'
Parameters
Key | Value/Type | Type | Description |
---|---|---|---|
userId | String | String | Enter your user ID. |
Responses
200: Success
{
"status": 200,
"message": "Delete organization successfully"
}
401: Unauthorized
{
"status": 401,
"message": "Invalid auth token"
}
500:Internal Server Error
{
"status": 500,
"message": "Something went wrong, please try again"
}