Documentation Powered by ReDoc

Intrapps API (1.0.0)

Download OpenAPI specification:Download

Intrapps api common description. Intrapps api method are either POST or GET. DELETE and PATCH api is not existed.

Common definition of Intrapps api

Common structure of GET api

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

The parameter is required in most post api.
But some post api doesn't request this parameter.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

The parameter is required in most post api.
But some post api doesn't request this parameter.

Responses

200

response of success

400
401
403
get /get-api-common-definition
/get-api-common-definition

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": "<--JSON CONTENTS-->"
}

Common structure of POST api

header Parameters
apikey
string (apikey)
Example: "xxxxxxxxxxx"

The parameter is required in most post api.
But some post api doesn't request this parameter.

secretkey
string (secretkey)
Example: "yyyyyyyyyyy"

The parameter is required in most post api.
But some post api doesn't request this parameter.

Responses

200

response of success

400
401
403
post /post-api-common-definition
/post-api-common-definition

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": "<--JSON CONTENTS-->"
}

signup and signin

Signup to Intrapps to create both of new vendor and user data.

"admin" or "user" is required as the authority of Intrapps user to call the api.

Request Body schema: application/x-www-form-urlencoded
username
required
string

username to login to Intrapps

password
required
string

password to login to Intrapps

email
required
string

E-mail address

family_name
required
string

family name

given_name
required
string

given name

company
required
string

company's name of vendor

country
required
string

country

province
required
string

province

city
required
string

city

address
required
string

town's data

telephone_number
required
string

telephone number

postalcode
required
string

postal code

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /signup
/signup

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

authorization of signup operation

New both of username and vendor require username and authorization code to confirm.

Request Body schema: application/x-www-form-urlencoded
username
required
string

username to login to Intrapps

code
required
string

authorization code in E-mail

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /signup_confirm
/signup_confirm

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

Login of Intrapps user.

Intrapps user login.

Request Body schema: application/x-www-form-urlencoded
username
required
string

username to login to Intrapps

password
required
string

password to login to Intrapps

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /login
/login

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

dashboard

Latest app list to be uploaded

Latest app list to be uploaded. 1 page includes 10 app. Maximum of page number is 10.

query Parameters
page_no
number
Example: 1

page no by 10 latest mobile app. up to 10.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

get /latest
/latest

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

project

Project list which belongs to vendor.

All project in the list belong to the vendor.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

get /projects
/projects

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

Project detail information.

New both of username and vendor require username and authorization code to confirm.

query Parameters
project_no
required
number
Example: 1

project number

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

get /project
/project

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

Add project data

"admin" or "user" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: multipart/form-data
project_name
required
string

(required) project name

project_overview
string

project overview's text

project_images
array

screenshot image data to add or update. Maximum number of member is 5.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /add_project
/add_project

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

edit project data

"admin" or "user" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: multipart/form-data
project_id
required
number

(required) project id to be updated

project_name
string

project name

project_overview
string

project overview's text

project_images_modify
array

0:keep, 1:add, 2:update, 3:delete. Number of member is 5.

project_images
array

screenshot image data to add or update. Maximum number of member is 5.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /edit_project
/edit_project

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

delete project data

"admin" or "user" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
project_id
required
number

(required) project id to be deleted

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /delte_project
/delte_project

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

app

Apps detail information.

New both of username and vendor require username and authorization code to confirm.

query Parameters
build_id
required
number
Example: 1

builder number

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

get /building
/building

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

Upload mobile app's file to be downloaded by Intrapps users.

"admin" or "user" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: multipart/form-data
build_app
required
object

(required) ipa or apk file

project_id
required
number

(required) project's project_id

release_note
string

app's release note text data

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /add_building
/add_building

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

Edit the uploaded mobile app's information.

"admin" or "user" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
build_id
required
number

(required) build id to be updated

release_note
string

app's release note text data

download_enabled
required
number

(required) 0:disable (the app can't be downloaded)
1:enable (the app can be downloaded)

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /edit_building
/edit_building

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

Delete the uploaded mobile app.

"admin" or "user" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
build_id
required
number

(required) build id to be updated

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /delete_building
/delete_building

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

report

add report text to app informaion.

"admin" or "user" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
build_id
required
number

(required) build id to be updated

note
required
string

(required) report text

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /add_report
/add_report

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

update report text which belongs to app's information.

"admin" or "user" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
build_id
required
number

(required) build id which this report text(id) belong to

report_id
required
number

(required) report id to be updated

note
required
string

(required) report text

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /edit_report
/edit_report

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

Delete the report text.

"admin" or "user" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
build_id
required
number

(required) build id which this report text(id) belong to

report_id
required
number

(required) report id to be updated

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /delete_report
/delete_report

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

user

Latest user list of Intrapps

"admin" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

get /users
/users

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

Latest user list of Intrapps

"admin" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

get /user
/user

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

add Intrapps user.

"admin" is required as the authority of Intrapps user to call the api.'

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
username
required
string

username to login to Intrapps

password
required
string

password to login to Intrapps

email
required
string

E-mail address

family_name
required
string

family name

given_name
required
string

given name

authority
required
number

0:admin, 1:user, 2:tester

user_manage_project_ids
Array of numbers

The array of project id which the user can access. If the property is null, the user has no project to access.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /add_user
/add_user

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

update Intrapps user's attribution.

"admin" is required as the authority of Intrapps user to call the api.'

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
user_id
required
number

Intrapps user's id

username
required
string

username to login to Intrapps

password
required
string

password to login to Intrapps

email
required
string

E-mail address

family_name
required
string

family name

given_name
required
string

given name

authority
required
number

0:admin, 1:user, 2:tester

user_manage_project_ids
Array of numbers

The array of project id which the user can access. If the property is null, the user has no project to access.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /edit_user
/edit_user

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

Delete user.

"admin" is required as the authority of Intrapps user to call the api.'

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
user_id
required
number

Intrapps user's id. But only one of admin user can't be deleted.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /delete_user
/delete_user

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

vendor

Vendor information of Intrapps

"admin" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

get /vendor
/vendor

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data":
    {
    }
}

update the vendor's information.

"admin" is required as the authority of Intrapps user to call the api.

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
company
required
string

The vendor's company name

contractor_user_id
required
number

User id of the vendor's manager. The user must be "admin".

country
required
string

country

province
required
string

province

city
required
string

city

address
required
string

town's data

telephone_number
required
string

telephone number

postalcode
required
string

Postal code

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /edit_vendor
/edit_vendor

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}

Delete vendor.

"admin" is required as the authority of Intrapps user to call the api.
The user must belong to the vendor which the user want to delete.'

header Parameters
apikey
required
string (apikey)
Example: "xxxxxxxxxxx"

Different random string is provided to every Intrapps user.
The data is listed in login api's response and User's page of Intrapps web.

secretkey
required
string (secretkey)
Example: "yyyyyyyyyyy"

Different random string is provided to every Intrapps vendor.
The data is included in login api's response and Vendor's page of Intrapps web.

Request Body schema: application/x-www-form-urlencoded
vendor_id
required
number

Vendor id to be deleted. The vendor must have the user which execute to delete.

Responses

200

Response of success. If you want to check error response, please see them in common spec page.

post /delete_vendor
/delete_vendor

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result":
    {
    },
  • "data": null
}