Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Calling API from launchpad vscode documentation #1989

Merged
merged 4 commits into from
Nov 29, 2024

Conversation

LukasKuzavas
Copy link
Contributor

@LukasKuzavas LukasKuzavas commented Nov 29, 2024

ATTENTION! NEW DOCS STRUCTURE
FOR THE NEXT THREE WEEKS, ONLY BRANCH FROM new-docs-structure
OTHERWISE, WAIT UNTIL THE NEW STRUCTURE HAS BEEN RELEASED


Adding section on sending API requests that covers requirements, how to get requirements and samples on using curl and postman to send API requests.


Thank you for contributing to the documentation.

Do the changes you have made apply to both Current and Previous versions?

Have you done a trial build to check all new or changed links?

Is there anything else you would like us to know?

This week's exciting advice from the style guide

  • Write your headings in sentence case:

    • A good example
      This is a correct heading.
    • A Bad Example
      This is not a correct heading.

@LukasKuzavas LukasKuzavas self-assigned this Nov 29, 2024
- Tokens stored in 'Cookie' header
- raw Body in json for details

An example for login would have `https://portal.dev.platform.genesis.global/workspace/<<WORKSPACE_ID>>/proxy/9064/event-login-auth` url.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drop .dev

}'
```

#### Proxy url
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Application url

```

#### Proxy url
To send requests to the application in the VSCode environment, you need the proxy url.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

application

4. use this as the base of your request

#### Tokens
There are 2 tokens you will need to extract from launchpad.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why two?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because it works without the first short token, have you gotten it to wok with one?


4. use this as the base of your request

#### Tokens
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Request headers

4. use this as the base of your request

#### Tokens
There are 2 tokens you will need to extract from launchpad.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets also briefly explains here what this mena,s as this is to allow secure authentication to your app...

4. Go to cookies in the sidebar and open the cookies for the website

There should be AWSELBAuthSessionCookie-0, AWSELBAuthSessionCookie-1.
You will be putting this in your requests
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

requests headers

@@ -499,6 +499,99 @@ To run any of these:
| `Start Server` | Starts all the App's Server processes. |
| `Start UI System Design Configurator`| Starts the Design Configurator. You must be on Foundation-UI 14.213.0 or later to use this. |

## Sending api requests

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggested structure:

Getting the required data

(move the content here)

Sending requests using postman

Sending requests using CLI

@LukasKuzavas LukasKuzavas marked this pull request as ready for review November 29, 2024 18:11
@rafaelnferreira rafaelnferreira merged commit 8e3bb54 into new-doc-structure Nov 29, 2024
@rafaelnferreira rafaelnferreira deleted the replace-unpack-step branch November 29, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants