Nota
A partir del 16 de septiembre, el nuevo dominio upload.applivery.io está disponible. Si anteriormente estabas integrado con el dominio api.applivery.io es importante que cambies al nuevo, ya que el antiguo endpoint ya no estará disponible después del 1 de diciembre.
Nota
Estás viendo la API de aplicaciones cuyo ámbito se limita a las aplicaciones. Si buscas la especificación API completa, consulta la API de Organizaciones.
Esta petición tiene como objetivo cargar una nueva Build (.ipa, .apk, .aab, .dmg, .pkg, .exe, .msi, .nsp, .zip, o .tar.gz).
Definición #
- Método: POST
- URL:
https://upload.applivery.io/v1/integrations/builds - Autenticación: requerida
- Encabezados:
Content-Type: application/json
Authorization: bearer <your_app_token> - Tipo de petición: Multipart.
Params #
| Param | Tipo | Descripción |
|---|---|---|
build
|
File |
.ipa, .apk, .aab , .dmg, .pkg, .exe, .msi, .nsp, .zip o .tar.gz
|
versionName
|
String |
Human readable version name for this build. E.g.: RC-1.
|
tags
|
Array |
Etiquetas separadas por comas. E.g.: tag1, tag2, tag3.
|
changelog
|
String |
Build release notes or log of changes E.g.: Bug fixing!.
|
filter
|
Nested array of strings |
List of groups that will be notified with support for AND / OR clauses. Cada elemento dentro del mismo array se considerará como AND, mientras que cada array será una cláusula OR. E.g.: To notify users in group1 AND group2 OR in group3 use: [["group1", "group2"],["group3"]].
|
buildPlatform
|
String |
iOS, macOS, android, ps4, ps5, switch, xbox-one, xbox-series.
|
packageName
|
String | Requerido si la Build no es procesable. |
packageVersion
|
String | Requerido si la Build no es procesable. |
packageIcon
|
File |
Requerido si la Build no es procesable (en formatos .png o .jpeg).
|
notifyCollaborators
|
Boolean |
Notify App and Organization collaborators. E.g.: true.
|
notifyEmployees
|
Boolean |
Notify App and Organization employees. E.g.: true.
|
notifyMessage
|
String |
Notification message to send in the email. E.g.: Enjoy the App!.
|
notifyLanguage
|
String |
"es", "en", "fr", "ge", "it", "zh", "pt", "ru".
|
deployer.name
|
String |
Custom deployer display name. E.g.: Jenkins CI.
|
deployer.info.commitMessage
|
String |
Git commit message. E.g.: Fixed issue #123.
|
deployer.info.commit
|
String |
Git commit. E.g.: f52ace0.
|
deployer.info.branch
|
String |
Git branch. E.g.:develop.
|
deployer.info.tag
|
String |
Git tag. E.g.: RC-1.
|
deployer.info.triggerTimestamp
|
String |
CI trigger date/time. E.g.: 1558359012580.
|
deployer.info.buildUrl
|
String |
CI build URL. E.g.: https://....
|
deployer.info.ciUrl
|
String |
CI platform URL. E.g.: https://....
|
deployer.info.repositoryUrl
|
String |
Version control repository URL. E.g.: https://....
|
deployer.info.buildNumber
|
String |
CI platform build number. E.g.: 73.
|
Ejemplo de petición #
curl 'https://upload.applivery.io/v1/integrations/builds' \
-X POST \
--retry 5 \
-H 'Authorization: bearer xyz...xyz' \
-F build=@'file.ipa' \
-F 'versionName=My awesome app version' \
-F 'tags=tag1, tag2, tag3' \
-F 'changelog=Bug fixing' \
-F notifyCollaborators=false \
-F notifyEmployees=false \
-F 'notifyMessage=Enjoy the App' \
-F 'notifyLanguage=en' \
-F 'filter[0][0]=group1' \
-F 'filter[0][1]=group2' \
-F 'filter[1][0]=group3' \
-F 'deployer.name=Custom CI PLatform' \
-F 'deployer.info.commitMessage=Fixed issue 123' \
-F 'deployer.info.commit=f52ace0' \
-F 'deployer.info.branch=develop' \
-F 'deployer.info.tag=RC-1' \
-F 'deployer.info.triggerTimestamp=1558359012580' \
-F 'deployer.info.buildUrl=http://www.applivery.io/build/73' \
-F 'deployer.info.ciUrl=http://www.applivery.io/ci' \
-F 'deployer.info.repositoryUrl=https://github.com/applivery/applivery-ios-sdk' \
-F 'deployer.info.buildNumber=173'
Respuestas #
Content type: application/json
{
"status": true,
"data": {
"id": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"application": "string",
"applicationInfo": {
"id": "string",
"slug": "string",
"name": "string",
"picture": "string"
},
"slug": "string",
"filter": {
"type": "last",
"value": "string",
"ios": "string",
"android": "string",
"windows": "string",
"macos": "string",
"builds": [
{
"buildPlatform": "string",
"id": "string"
}
]
},
"security": "public",
"tags": [
"string"
],
"groups": [
[
"string"
]
],
"visibility": "active",
"showHistory": true,
"showDevInfo": true,
"distributionUrl": "string",
"terms": {
"active": true,
"text": "string"
}
}
}
Content type: application/json
{
"status": false,
"error": {
"code": 5024,
"message": "Slug already used"
}
}
Content type: application/json
{
"status": false,
"error": {
"code": 3002,
"message": "Token Expired"
}
}
Content type: application/json
{
"status": false,
"error": {
"code": 3001,
"message": "Entity not found"
}
}
