Endpoints
Preparação para as lojas
O que um app ainda precisa para o Google Play e a App Store, e os passos em ordem.
https://www.setherion.com/api/v1/projects/{id}/storePlano: Qualquer plano
A janela “Publish to app stores” do editor, dita em forma de dados: o que está pronto para as lojas e, com way, os passos para Android e iPhone em ordem. Ela lê o código salvo do app com os mesmos auxiliares da janela, então nunca discorda dela.
É gratuito e não usa créditos. O acesso de visualizador basta. Para ver as janelas e o passo a passo completo, veja Publicar nas lojas de apps.
Solicitação
Sem way, para comparar primeiro os dois caminhos:
curl https://www.setherion.com/api/v1/projects/7c1e4a52-9b0d-4f3e-8a61-2d5f0c9e7b14/store \
-H "Authorization: Bearer $SETHERION_API_KEY"Com way, para ver os passos:
curl "https://www.setherion.com/api/v1/projects/7c1e4a52-9b0d-4f3e-8a61-2d5f0c9e7b14/store?way=easy" \
-H "Authorization: Bearer $SETHERION_API_KEY"| Parâmetro | Significado |
|---|---|
way | Opcional. easy ou native. easy empacota o site publicado em pacotes para as lojas com o PWA Builder, sem código. native é o app inteiro como um projeto de celular que o dono compila em um computador, necessário para anúncios e compras dentro do app. Qualquer outro valor responde 400. |
O app precisa ter código. Se estiver publicado, a chamada também pede ao app no ar o seu ícone para as lojas (/icon-512.png), esperando no máximo 5 segundos.
Resposta sem way
{
"ok": true,
"app": { "name": "Coffee shop", "url": "https://coffee-shop.setherion.app" },
"ready": [
{
"item": "Published on the web",
"state": "ok",
"note": "https://coffee-shop.setherion.app"
},
{
"item": "Store icon",
"state": "ok",
"note": "PNG in every size the stores ask for, made when the app is published."
},
{
"item": "Privacy policy page",
"state": "missing",
"note": "Both stores ask for a link to one, and none was found in this app.",
"fix": "Add a Privacy Policy page at /privacy, linked from the footer and from the sign-up screen. Say what the app keeps (the account email and what people enter), why, for how long, that nothing is sold, and how to ask for an account and its data to be deleted. Leave the owner's contact email as a placeholder to fill in."
}
],
"ways": {
"easy": "Easy, no code: PWA Builder wraps the published website into store packages. About 2 steps in Setherion, the rest in the stores. Android is done from any computer; iPhone needs a Mac with Xcode.",
"native": "Native, for developers: the whole app as a phone project (Capacitor). Needed for ads and in-app purchases. Built on the owner's computer (Android Studio; a Mac with Xcode for iPhone), or in the cloud by GitHub when pushed to GitHub: no Android Studio and no Mac."
},
"onlyInSetherion": "In Setherion: open the app, Publish, then \"Publish to app stores\". Only there: dropping PWA Builder's ZIP, adding Google Play's key, downloading the phone project or pushing it to GitHub, the store screenshots (every size both stores ask for, free), and the store guidelines check. The window ticks the steps it can see, and keeps the owner's own ticks."
}| Campo | Tipo | Significado |
|---|---|---|
app | objeto | O name do app e a sua url, ou null quando ele não está publicado. |
ready | lista | O que está pronto e o que falta. Veja abaixo. |
ways | objeto | Uma frase para cada caminho, easy e native. |
onlyInSetherion | texto | O que só a janela do Setherion consegue fazer, para que um programa saiba onde termina o seu alcance. |
A lista ready
Cada entrada tem item, state e note, e às vezes fix.
| Campo | Significado |
|---|---|
item | O que é verificado. |
state | ok, missing, ou unknown quando não foi possível verificar agora. |
note | Uma frase dizendo o porquê. |
fix | Só em um item missing que o editor pode adicionar. O texto a enviar para Editar um app como prompt, depois que o dono concordar, porque uma edição gasta créditos. |
Os itens que podem aparecer
- Published on the web.
okquando o app tem um endereço.missingquando não tem: o caminho Easy empacota o endereço publicado, então publique primeiro. O caminho Native funciona sem isso. - Store icon. Só aparece depois que o app é publicado.
okquando o app no ar serve o ícone PNG,missingquando não serve (publique de novo; um app em um domínio próprio tem por enquanto só o ícone SVG),unknownquando não foi possível verificar o app no ar. - Delete account button. Só aparece quando as pessoas podem se cadastrar no app. A Apple recusa um app assim sem esse botão.
missingtem umfix. - Privacy policy page. As duas lojas pedem um link para uma.
missingtem umfix.
Resposta com way
Os mesmos campos, mais os passos do caminho que você pediu:
{
"ok": true,
"app": { "name": "Coffee shop", "url": "https://coffee-shop.setherion.app" },
"ready": [ "... as above ..." ],
"ways": { "easy": "...", "native": "..." },
"way": "easy",
"android": [
{
"step": 1,
"title": "Make the Android package",
"meta": "PWA Builder, about 2 minutes",
"detail": "Open PWA Builder with the app's address filled in. Choose Package for stores, then Android, and download the ZIP.",
"link": "https://www.pwabuilder.com/reportcard?site=https%3A%2F%2Fcoffee-shop.setherion.app"
},
{
"step": 2,
"title": "Link the app to your site",
"meta": "So it opens without a browser's address bar",
"detail": "In Setherion: open the app, Publish, then \"Publish to app stores\", Easy, Android, this step: drop the ZIP from PWA Builder there. ...",
"done": false
}
],
"iphone": [ "... five steps, numbered the same way ..." ],
"iphoneNotes": [
"A Mac is needed. The Easy way builds the iPhone app on a Mac with Xcode. The Native way can build it on GitHub's Mac computers instead. Make sure you have one of the two before you pay Apple's $99 a year.",
"To Apple this looks like a website. Nobody signs in, nothing is saved, and Apple turns down apps that are only a website (guideline 4.2). Sign-in, saved data and features people come back to make it an app. Run the store guidelines check on the first page before you send it."
],
"onlyInSetherion": "..."
}(Abreviado aqui: a resposta real traz cada passo completo.)
| Campo | Tipo | Significado |
|---|---|---|
way | texto | O caminho pedido, easy ou native. |
android | lista | Os passos do Android, em ordem. |
iphone | lista | Os passos do iPhone, em ordem. |
iphoneNotes | lista de textos | Motivos pelos quais a Apple pode recusar o app, cada um uma frase, com o título que a janela dá. |
Cada passo tem:
| Campo | Tipo | Significado |
|---|---|---|
step | número | Sua posição na lista, a partir de 1. |
title | texto | O nome do passo, o mesmo que a janela mostra. |
meta | texto | Uma linha curta: quanto tempo leva, o que precisa ou quanto custa. |
detail | texto | O que fazer. Pode ter várias linhas, como os comandos a executar. |
link | texto | Onde fazer, quando há um lugar. Fica de fora nos outros casos. |
done | booleano | Só nos passos que o Setherion consegue ver por conta própria no caminho Easy para Android: o link com o seu site e a chave do Google Play. Fica de fora quando ele não sabe dizer. |
Os passos de cada lista
Easy, Android: criar o pacote Android, vincular o app ao seu site, abrir uma conta de desenvolvedor do Google Play, enviá-lo e testá-lo, adicionar a chave do Google Play, preencher a página da loja e lançar.
Easy, iPhone: abrir uma conta de desenvolvedor da Apple, criar o pacote para iPhone, compilá-lo e enviá-lo, testá-lo no seu iPhone, preencher a página da loja e enviá-lo para revisão.
Native, Android: baixar o projeto, compilá-lo, assiná-lo, enviá-lo e testá-lo, lançar.
Native, iPhone: baixar o projeto, compilá-lo, assiná-lo e enviá-lo, testá-lo no seu iPhone, preencher a página da loja e enviá-lo para revisão.
No caminho Native, os comandos em detail incluem o passo extra de configuração quando o app mostra anúncios ou vende coisas, e as notas de publicidade e de compras dentro do app para os formulários das lojas.
Erros
| Status | Quando |
|---|---|
400 | way é algo diferente de easy ou native. |
401 | A chave está ausente, errada ou foi revogada. |
404 | Não existe esse app, ou a sua chave não consegue abri-lo. |
409 | O app ainda não tem código. Crie-o primeiro no Setherion. |
As frases exatas
| Status | error |
|---|---|
400 | way is "easy" or "native". |
404 | No such app on this account. |
409 | This app has no code yet. Build it in Setherion first. |
Esta página foi útil?
