Postman 시작하기

이 튜토리얼에서는 Postman이 무엇인지와 Postman 사용 환경을 빠르게 설정하는 방법에 대해 알아봅니다.

​

소개

Postman은 데스크톱 및 웹 애플리케이션으로, 그래픽 사용자 인터페이스를 통해 API에 요청을 보낼 수 있는 도구입니다. API의 기능을 살펴볼 때뿐만 아니라 애플리케이션 문제를 해결할 때도 X API, X Ads API, Labs 엔드포인트와 함께 Postman을 사용할 것을 권장합니다. 

현재 다음 두 가지 Postman 컬렉션을 제공하고 있습니다:

X API v2 Collection

X Ads API Collection

​

사전 준비 사항

X의 Postman 컬렉션을 사용하기 전에, 사용하려는 X 개발자 플랫폼 도구에 대해 적절한 액세스 권한과 자격 증명을 보유하고 있는지 확인해야 합니다. 액세스 권한을 얻는 방법은 “시작하기” 페이지에서 자세히 알아볼 수 있습니다. 

개발자 계정을 보유하고, developer App을 설정했으며, authentication 키와 토큰을 발급받고, 사용하려는 특정 API에 요청을 보낼 수 있도록 환경까지 올바르게 구성했다면, 아래 단계를 따라 시작할 수 있습니다.  

​

X의 Postman 컬렉션 사용 시작하기

​

1단계: X Postman 컬렉션 중 하나를 계정에 추가하기

Postman에서 직접 사용하려는 엔드포인트를 하나씩 구성할 수도 있지만, 이미 이 작업이 완료된, 바로 사용할 수 있는 관련 API 컬렉션을 제공하고 있습니다. 앞의 “Postman collections” 섹션에 있는 링크 중 하나를 클릭하면, 선택한 API와 연결된 모든 엔드포인트가 포함된 컬렉션이 사용자의 Postman 앱에 추가됩니다. 이 컬렉션들은 Postman API network에서도 사용할 수 있습니다. 각 엔드포인트에는 사용 가능한 매개변수, 예제 응답, 그리고 인증 유형이 자동으로 설정되어 있으므로, 자격 증명과 매개변수 값만 추가하면 바로 기능을 살펴볼 수 있습니다.

이 예제에서는 X API v2 collection을 사용해 보겠습니다.   

​

Step two: 키와 토큰을 환경 변수로 추가하기

컬렉션을 Postman 인스턴스에 추가하면 자동으로 ‘X API v2’라는 환경이 생성되며, 여기에 키와 토큰을 추가해야 합니다. 이 단계에서는 개발자 App에서 발급받은 키와 토큰을 ‘X API v2’ 환경에 추가하는 과정을 단계별로 안내합니다. 

키와 토큰을 “X API v2” 환경에 추가하려면, Postman 오른쪽 상단에 있는 “manage environments” 버튼을 클릭하세요. 경우에 따라 먼저 오른쪽 상단의 설정 버튼을 클릭해야 할 수도 있습니다.   

환경 목록에서 “X API v2”를 클릭합니다. 

다음으로, Apps 대시보드에서 생성한 각종 키와 토큰에 대해 변수를 테이블에 모두 추가합니다. 테이블은 다음 예시와 같은 형태가 되어야 합니다:

VARIABLE	INITIAL VALUE	CURRENT VALUE
consumer_key	QAktM6W6DF6F7XXXXXX	QAktM6W6DF6F7XXXXXX
consumer_secret	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX
access_token	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX
token_secret	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX
bearer_token	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX

위 테이블에 사용된 키와 토큰은 예시용으로 임의로 생성된 값이며, 실제 요청에 사용해도 동작하지 않습니다. 

자격 증명을 변수로 모두 추가하고 X API v2 환경이 선택되어 있는 것을 확인했다면, 이제 X API v2 컬렉션에 요청을 보낼 준비가 된 것입니다. 각 endpoint의 Authorization 탭이 이 환경에서 변수를 자동으로 상속받도록 설정되어 있기 때문입니다. 

Postman에서 User Access Token을 사용하는 방법에 대해서는 XXXX로 건너뛰어 추가 세부 정보를 참고하세요.

​

3단계: 엔드포인트 선택

다음으로 컬렉션에서 엔드포인트를 선택해 요청 작성을 시작합니다. 오른쪽 탐색 영역에서 엔드포인트를 선택할 수 있습니다. 아래와 같이 표시됩니다:

이 예제에서는 X API v2 > Post Lookup > Single Post 엔드포인트를 사용합니다. 

​

4단계: Params 탭에 값 추가하기

다음으로 Params 탭으로 이동합니다. 비활성화된 여러 개의 파라미터와 각 파라미터의 동작을 설명하는 설명, 그리고 요청에 함께 전달할 수 있는 모든 가능한 값 목록이 보일 것입니다. 

이 예제에서는 expansions 및 tweet.fields 쿼리 파라미터를 활성화하고 다음 값을 추가합니다:

Key	Value
tweet.fields	created_at,attachments
expansions	author_id

쿼리 파라미터를 추가하는 것 외에도 필수 Path Variable인 id를 추가해야 합니다. 이 엔드포인트는 포스트를 반환하므로, 값으로 유효한 게시물 ID를 추가해야 합니다.

게시물 ID는 x.com으로 이동한 뒤 게시물을 클릭하고 URL을 확인하여 찾을 수 있습니다. 예를 들어, 다음 URL의 게시물 ID는 1228393702244134912입니다:

https://x.com/XDevelopers/status/1228393702244134912

Params 탭에서 모든 쿼리 파라미터를 지나 아래로 스크롤하면 “Path Variables” 섹션이 표시됩니다. 여기에서 사용하려는 게시물 ID를 id 키의 값으로 추가합니다.

이 단계의 모든 내용을 올바르게 입력했다면, Params 탭은 다음과 같이 표시될 것입니다:

​

5단계: 요청을 전송하고 응답을 검토하기

이제 요청에 필요한 모든 설정을 완료했으므로 “Send” 버튼을 클릭하면 됩니다. 

모든 설정이 올바르게 구성되었다면, 다음과 같은 페이로드를 받게 됩니다.

{
    "data": {
        "author_id": "2244994945",
        "text": "What did the developer write in their Valentine’s card?\n  \nwhile(true) {\n    I = Love(You);  \n}",
        "id": "1228393702244134912",
        "created_at": "2020-02-14T19:00:55.000Z"
    },
    "includes": {
        "users": [
            {
                "username": "XDevelopers",
                "name": "개발자",
                "id": "2244994945"
            }
        ]
    }
}

​

Postman으로 사용자 액세스 토큰 생성하기:

​

OAuth 1.0a를 사용하여 사용자 액세스 토큰 생성하기

OAuth 1.0a flow test collection에 사용된 3단계 프로세스를 검토하세요.

​

OAuth 2.0를 사용하여 사용자 액세스 토큰 생성하기

Postman에서 OAuth 2.0 사용자 액세스 토큰을 생성하려는 경우, X API v2 Postman collection과 함께 사용할 OAuth 2.0 액세스 토큰을 생성할 수 있습니다. 

워크스페이스에서 컬렉션을 클릭한 후 “Auth” 탭으로 이동해 type을 “OAuth 2.0”으로 선택합니다. 그런 다음 “Configure New Token” 섹션 아래에서 “Configuration Options”라고 표시된 곳으로 이동합니다. 여기에서 “Grant Type”을 “Authorization Code (With PKCE)”로 변경할 수 있습니다.

Callback URL을 App과 연결된 Callback URL과 일치하도록 업데이트해야 합니다. 또한 다음 매개변수도 업데이트해야 합니다:

• Auth URL -  https://x.com/i/oauth2/authorize
• Access Token URL -  https://api.x.com/2/oauth2/token
• Client ID - Dev Portal에서 발급받은 OAuth 2.0 client ID
• Client Secret - confidential client를 사용하는 경우
• Update Scope - 연결하려는 엔드포인트에 맞는 scopes. 예: “tweet.read users.read” 
• Callback URL(redirect URL이라고도 함). 이는 App의 authentication 설정에 지정한 값과 반드시 일치해야 합니다.
• State - state

준비가 되면 “Get New Access Token”을 클릭해 Access Token을 생성할 수 있습니다. “문제가 발생했습니다”라는 내용의 대화 상자가 표시되면, 로그인하기 위해 뒤로 가기 버튼을 눌러야 할 수 있습니다. 대화 상자에서 “Authorize app”이라고 표시된 버튼을 클릭해 App이 계정에 접근할 수 있도록 권한을 부여해야 합니다.

App에 권한을 부여한 후에는 Postman으로 다시 리디렉션되며, 여기에서 토큰을 확인하고 “Use Token” 버튼을 선택해 인가된 사용자를 대신해 요청을 보내기 시작할 수 있습니다.

이제 Postman collection을 사용할 준비가 되었습니다.

​

다음 단계

Postman에서 “Code”라고 표시된 버튼을 클릭하면 방금 만든 요청을 Python, Node, Ruby와 같은 원하는 언어로 변환하여 빠르게 시작할 수 있습니다. Postman에는 참고하기 좋은 문서가 잘 정리되어 있습니다. 또한 엔드포인트와 더 빠르게 통합하는 데 도움이 되는 GitHub의 샘플 코드도 제공합니다.