Home

⚖️ LFA API 문서

✅프로젝트 소개

• 'NE(O)RDINARY(너디너리-Soft Squared)/인하대 창업지원단'에서 주최하는 '원데이 프로덕트 챌린지' 참여하여 팀 프로젝트를 진행합니다. 챌린지에서 공익 소송 매칭 서비스 개발을 위한 API 문서입니다.
• 필요성
  • 공익단체: 특정 사건 (ex-장애인 이동권 문제) 공론화하고 싶어서 해당 피해자를 찾고 싶으나 찾기 힘듦.
  • 사건 피해당사자: 공익단체 통해 소송 진행하고 싶지만, 대부분 어떤 단체에 연락해서 도움을 받아야되는지도 모르고 모르는 사람들한테 자기 사건 공개하기 부담스러워함.
• 주요 기능
  • 자동 추천 기능
    1. 피해 당사자가 카테고리를 선택하면 추천 기관 목록 조회 가능
  • 매칭 기능
    1. 피해 당사자가 사건 입력 시 카테고리를 입력하면 해당 기관으로 알림 전송
    2. 알림을 받은 기관은 수임 여부 결정 가능
    3. 피해 당사자는 수임을 결정한 기관의 목록 조회 가능

✅공통 요청/응답 형식

1. 요청 데이터 형식: json 등
2. 응답 성공, 실패 여부: success 필드에서 성공 실패 설명/상태 코드를 통해 제공

✅공통 에러

만약 API 간 공통되는 에러 코드가 존재한다면, 문서의 한 섹션에 에러 코드를 모아두고 관리를 하는 것이 효율적입니다. 문서의 한 섹션에 공통 에러를 제공하면 각 API에 에러 코드를 각각 추가하지 않아도 되고, 변경도 한 곳에만 하면 되니 테크니컬라이터 입장에서는 문서 정합성 유지에도 큰 도움이 됩니다.

✅가이드

• 사전 작업
  • 시작 가이드에는 사전에 인증키(App key)를 어떻게 발급할 수 있고 어떤 용도로 사용되는지 상세히 설명되어야 합니다.
• API 사용 시퀀스
  • API 사용 시퀀스가 존재한다면 넘버링 형식으로 시퀀스를 정리하는 것이 좋습니다.

✅API 리스트업

API종류	API명	설명	완료여부
계정 관리	회원가입	개인/단체 회원가입	o
	회원 로그인	개인 사용자 로그인: 이메일, 비밀번호	o
	단체 로그인	단체 로그인: 이메일, 비밀 번호	o
단체 매칭	카테고리별 게시글 목록	단체에서 사용자가 작성한 게시글 목록을 조회	o
	사용자 개인 게시글 목록	사용자 개인 본인이 작성한 게시글 목록을 조회	o
	게시글 상세	개별 게시글 상세 내용을 조회	o
	게시글 등록	게시글을 생성	o
	게시글 수정	게시글을 업데이트	o
	게시글 삭제	게시글을 삭제	o
단체 추천	카테고리 목록	카테고리 목록 나열
	카테고리별 단체 목록	카테고리별 단체 목록 조회
	단체 상세	단체 정보 조회

✅참고

• 카카오엔터프라이즈 기술블로그 Tech&(테크앤):티스토리
• kakao i 기술문서